Cumu Scrive Manuali d'Usuariu Chjari è Concisi
Cosa hè un manuale d'utilizatore?
Ci sò diversi nomi per un manuale d'utilizatore. I ducumenti tecnichi, i manuali di mantenimentu è i manuali d'istruzzioni sò tutti nomi chì si riferiscenu à u stessu articulu. Un manuale d'utilizatore hè fattu per aiutà i clienti à aduprà u vostru pruduttu o serviziu currettamente o risolve i prublemi chì succedenu durante l'usu. Puderanu esse dispunibuli in stampa, digitale, o dui formati.
I manuali d'utilizazione furniscenu à l'utilizatori finali struzzioni cumpletu, passu per passu è qualchì supportu per i prublemi. Una tabella di cuntenutu deve esse presente in ogni manuale d'utilizatore perchè sò materiali di riferimentu piuttostu cà libri chì deve esse lettu da u principiu à a fine. Duvete aghjunghje un tutoriale di avviu rapidu o di startup in u vostru manuale d'utilizatore in modu chì l'utilizatori ponu sentenu facilmente à facilità à cumincià à aduprà u pruduttu.
tipi di manuali d'usu
Per una varietà di sughjetti è obiettivi, i manuali d'utilizatori ponu esse pruduciuti. Eccu alcuni di e vostre pussibulità, allora guardemu elli.
- Manuale d'istruzzioni
Un manuale d'istruzzioni hè un tipu di guida d'utilizatore chì offre struzzioni diretti per utilizà un pruduttu in a manera chì era destinatu à esse usatu. - Manuale di furmazione
Stu tipu di guida d'utilizatore offre una lista di linee guida per finisce un certu travagliu, prughjettu o travagliu. - Manuale di serviziu
I manuali di serviziu sò guide di l'utilizatori chì descrizanu cumu guardà è mantene un pezzu di machina o equipaggiu in diverse stages di a so vita. - Manuale d'usu
I manuali d'utilizatori sò publicazioni tecniche chì spieganu cumu utilizà o operare un pruduttu bè. - Manuale d'operazione
I roli, i duveri è e prucedure specifiche per un affari o urganizazione sò descritti in i manuali di operazione. - Manuale di pulitica di l'urganisazione
Un manuale di pulitica di l'urganizazione hè a documentazione chì definisce e pulitiche, e pratiche è e pratiche megliu di una cumpagnia. - Manuale di Procedure Operative Standard (SOP).
L'utilizatori beneficianu di e istruzioni dettagliate di un manuale di prucedure operative standard per eseguisce e prucedure stabilite.
Perchè a vostra attività hà bisognu di manuali d'utilizatore?
E persone sò megliu equipate per trattà i prublemi per sè stessu cù u supportu di un manuale d'utilizatore. Un manuale d'utilizatore decentu pò dà à i vostri clienti l'attrezzi chì anu bisognu per ottene rapidamente è efficacemente u valore chì desideranu da u vostru pruduttu o serviziu in a cultura di gratificazione immediata d'oghje.
Un eccellente serviziu di u cliente deve esse cumplementatu cù manuali d'utilizatore. A scrittura di manuali d'utilizatore eccellenti furnisce l'avanzatu seguentetages per a vostra cumpagnia:
- Per fà l'imbarcu è a furmazione più simplice
Guide d'utilizatore ben scritte ponu simplificà e prucedure di imbarcu è di furmazione. Hè currettu, sviluppendu è implementendu manuali d'utilizatore di prima qualità, i vostri impiegati è i vostri cunsumatori anu da guadagnà.
A vostra cumpagnia pò aduprà guide d'utilizatori per aiutà à i novi impieghi à passà per alcuni di i prucessi è i sistemi chì facenu parte di i so novi roles piuttostu cà solu di stallà sessioni di furmazione in persona difficili, chì anu un tempu è spese finanziarie significative. Siccomu l'impiegati ponu amparà mentre svolghjenu e funzioni relative à e so pusizioni per via di e guide d'utilizatore, pò esse menu ore perse durante l'imbarcu. - Per riduce a spesa di supportu
I guidi di l'utilizatori sò un grande aghjuntu à i vostri sforzi di serviziu di u cliente per u cunsumadore, ma serve ancu à u pruprietariu di l'affari cum'è un cumpunente di u sistema di supportu di u cliente.
I clienti sò più prubabile di truvà solu solu solu è sò menu prubabile di avè bisognu di cuntattà un tecnicu o un rappresentante per un supportu specializatu quandu li dete un accessu rapidu à una guida d'utilizatore cercabile. - Per cunservà u tempu
Sia i vostri clienti è i vostri impiegati, da u staffu di l'entry-level à a gestione, ponu risparmià tempu usendu manuali d'utilizatore. Quandu i manuali di l'utilizatori sò dispunibuli per i vostri clienti, ùn anu micca bisognu di perdiri u tempu per pruvà à truvà infurmazioni nantu à cumu utilizà un pruduttu perchè anu accessu direttu à quella infurmazione subitu.
Quandu i vostri impiegati sò dotati di manuali utili d'utilizatori, ùn anu micca bisognu di perde u tempu in modu indipendenti à circà suluzioni o monopolizà l'attenzione di i so cumpagni è i dirigenti cù e dumande perchè anu accessu à e soluzioni ghjustu in u so manuale d'utilizatore! - Per minimizzà a responsabilità
Un approcciu per dimustrà chì avete testatu u vostru pruduttu bè è sapete cumu aduprà in modu sicuru hè di scrive è distribuisce manuali d'utilizatore. Questu pò riduce significativamente ogni obbligazione cunnessa cù a produzzione di qualcosa per u publicu generale.
Avè avvisi è precauzioni di sicurità scritte è resi accessibili à l'utilizatori via una guida d'utilizatore hè un modu efficace (ma micca infallibile) per evità prublemi legali ligati à ferite o altri danni causati da abusu se u pruduttu chì vende puderia esse periculosu per l'utilizatori (pensate). riscaldatori spaziali, arnesi elettrici, etc.).
Chì cumpunenti custituiscenu i migliori manuali d'utilizatore?
Ci sò alcune pratiche megliu di documentazione di l'utilizatori finali per aderisce à qualunque cosa, ancu s'è ogni pruduttu hè unicu è avarà bisognu di cumpunenti distinti per generà una documentazione d'utilizatore veramente eccellente.
- Lingua chjara
Nunda ùn irriterà più i vostri clienti - fora di ùn offre micca unu - chì scopre u so manuale d'utilizatore hè pienu di jargon è di lingua difficiuli di capiscenu. I vostri struzzioni per l'utilizatori sò difficiuli d'utilizà per via di queste scelte di lingua, chì ancu ùn prumove micca un serviziu di u cliente eccezziunale. Assicurendu chì scrivite per l'utilizatore, micca u sviluppatore, hè un cumpunente cruciale di creà grandi guide d'utilizatori. Ùn assume micca chì u vostru utilizatore finale sapi o cunnosci qualcosa. L'acronimi, u jargonu è a terminologia di l'uffiziu farà chì i vostri clienti si sentenu malinformati, frustrati è impreparati. U puntu dolce per a produzzione di un manuale d'utilizatore hè un equilibriu trà ùn scrive micca cum'è i vostri cunsumatori sò zitelli (salvo chì, sicuru, sò!) lingua. - Simplicità
A scrittura di un manuale d'utilizatore richiede di mantene e cose simplici. Stu cuncettu deve esse riflessu in u cuntenutu è u disignu. Sè avete overstuff a vostra ducumentazione cù stampi intricati è longhi passaggi di testu, vi pare troppu sofisticatu è difficiule di capiscenu. Stu tipu di manuale d'utilizatore hè prubabile di intimidà u vostru utilizatore è li guidà à chjamà a vostra linea d'aiutu piuttostu cà di pruvà à scopre u so prublema per sè stessu. - Visuals
A massima "Mostra, ùn dite micca" hè una basa di scrittura manuale d'utilizatore. I screenshots annotati, i filmi è altri cuntenutu visuale sò estremamente utili per capiscenu i cuncetti. Hè spessu assai più utile per vede qualcosa in azzione cà per leghje nantu à questu. I visivi ùn solu rompenu passaggi longu di testu, ma ancu riducenu a quantità di testu in i manuali d'utilizatore chì ponu esse spaventosi. Hè statu dimustratu chì e persone conservanu l'infurmazioni visuali 7% più rapidamente cà l'infurmazioni scritte. In un studiu Techsmith, hè statu ancu dimustratu chì u 67% di e persone anu realizatu i travaglii in modu più efficau quandu anu datu struzzioni chì includenu screenshots annotati invece di parolle solu per trasmette infurmazioni. - Focus nantu à u prublema per esse risolta
Hè abbastanza prubabile chì qualchissia hà compru u vostru pruduttu per trattà un prublema. Hè essenziale per stà focu annantu à questu prublema quandu si scrive u manuale d'utilizatore chì serà inclusu cù u pruduttu. Invece di enumerazione è discussione di tutte e caratteristiche chì u vostru pruduttu offre o l'elementi di design intriganti chì avete incorporatu, informate i vostri utilizatori nantu à elli in una manera chì facilita l'usu di u pruduttu. Mettite u prublema chì hè risolta in u cuntestu di e caratteristiche è i benefici di u vostru produttu quandu li descrive. - Flussu logicu è ghjerarchia
Per fà apparente à l'utilizatori ciò chì amparanu da ogni sezione di u vostru manuale d'utilizatore, utilizate intestazioni è sottotitoli chì seguitanu una struttura gerarchica chjara. Per guidà senza sforzu i vostri clienti attraversu tuttu ciò chì anu bisognu di sapè da u principiu à a cunclusione, a ghjerarchia chì sceglite deve seguità un flussu logicu. Assicuratevi di principià cù i fundamenti è incorpore una progressione logica versu e funzioni più sofisticate di u vostru pruduttu. - Lista di cuntenuti
A vostra guida d'utilizatore serà più utile à i lettori s'ellu principia cù una tabella di cuntenutu. Senza avè da scavà à traversu parechje pagine d'infurmazioni chì ùn sò micca in relazione cù u prublema attuale chì anu affruntatu, hè un approcciu familiarizatu per qualchissia per esplurà rapidamente è facilmente un documentu. - Fate a ricerca
Ancu s'è pudete stampà i vostri manuali d'utilizatore, hè prubabile chì a documentazione digitale serà a vostra priorità principale. Hè abbastanza prubabile chì i vostri manuali d'utilizatori seranu utilizati u più freti in un formatu digitale in un mondu induve a maiò parte di e persone anu un smartphone cun elli in ogni mumentu. Aghjunghjendu una funzione di ricerca à i vostri manuali di l'utilizatori digitale prumove una facilità d'utilizazione piacevule per l'utilizatori chì cercanu di risolve un prublema accedendu à questu, simile à cumu una tavola di cuntenutu serve per dirige l'utilizatori à u locu propiu in un documentu stampatu. - L'accessibilità
Hè pussibule chì alcune di e persone chì necessitanu u vostru manuale d'utilizatore puderanu prufittà di assistenza extra per assicurà chì funziona bè. Indipendentemente da esse richiesti da a lege, i requisiti di accessibilità sò generalmente una bona pratica. Mantene i requisiti di accessibilità in i vostri manuali d'utilizatore hè solu una pratica cummerciale eccellente. Cuncepisce guide d'utilizatori cun cuntenutu accessibile per l'utilizatori chì puderanu avè sfide visuali, audibili o cognitive hè cruciale. - Ben cuncepitu
Cunsiderate u vostru audience quandu creanu e vostre guide d'utilizatore. Seranu assai più inclini à usà in modu efficace se fate qualcosa chì piace à fighjà! Evite aduprà blocchi di testu longu è furnisce assai spaziu biancu. Cumminendu queste duie caratteristiche pò aiutà i cunsumatori parenu menu spaventosi è fà chì l'apprendimentu di qualcosa di novu pare eccitante invece di minaccia. L'approcciu di "mostra, ùn dì micca" chì avemu descrittu prima si applica ancu quì. Per i manuali d'utilizatori stampati è digitali, aghjunghje visuale è foto à u testu hè una alternativa fantastica. Per i manuali d'utilizatore digitale, i video è i GIF offrenu interessu è un elementu utile. Se a vostra cumpagnia hà una guida di stile, u vostru disignu deve seguità; altrimenti, sè operate senza unu, hè cruciale per mantene a vostra guida d'utilizatore coherente. I fonti è i schemi di culore utilizati in tutta a carta, è idealmente in tutte e vostre guide d'utilizatori, deve esse coherente. - Cumenti da i clienti attuali o beta tester
Ùn puderete micca determinà se e guide d'utilizatore chì avete preparatu sò u più successu pussibule finu à chì avete cercatu è ascoltatu i feedback da e persone chì anu daveru aduprà u vostru pruduttu. I guidi di l'utilizatori chì sviluppate per u vostru pruduttu duveranu piglià in contu i prublemi chì a ghjente hà cun ellu. Puderete amparà qualcosa chì pare assai apparente, ma ci hè una chance assai megliu chì amparà qualcosa chì vi aiuterà à capisce i bisogni di i clienti chì cercate di ghjunghje.
Cumu scrive un manuale d'utilizatore?
Fà un manuale d'utilizatore hè un compitu cruciale chì pò avè un grande impattu à a vostra cumpagnia è à i cunsumatori chì vulete serve. Avemu simplificatu u prucessu di sviluppà un manuale d'utilizatore in modu chì pudete seguità facilmente perchè pò esse sbulicatu.
- Identificà l'utilizatori
Truvà u destinatariu di a vostra cumunicazione hè un passu iniziale essenziale, cum'è cù qualsiasi altra cumunicazione chì generate. L'audienza destinata di u vostru manuale d'utilizatore vi aiuterà à decide nantu à tematiche cum'è u tonu, u livellu di dettagliu per furnisce, è cumu furnisce u cuntenutu. Scrivite una guida d'utilizatore per l'utilizatore finale di u vostru pruduttu hè significativamente sfarente da scrive una per un ingegnere tecnicu. U primu passu hè di determinà u vostru audience. - Focus nantu à u prublema
I manuali d'utilizatore sò fatti per aiutà à risolve i prublemi o instruisce à qualcunu cumu fà qualcosa di novu. Duvete determinà precisamente ciò chì u vostru manuale d'utilizatore hè destinatu à fà è assicuratevi di mantene quellu focus.
Pò esse tentatore di allargà u tema è di discussione numerose funzioni o applicazioni per u vostru pruduttu. Questu pò frustà l'utilizatori è guidà à chjamate à a vostra linea di supportu à i clienti annebbiandu a risposta vera chì necessitanu.
Se u vostru cliente hè un cunsumadore chì impara à utilizà u pruduttu o un tecnicu chì hà bisognu di riparà, cuncentrate nantu à a suluzione precisa chì avarà bisognu. - Aduprate un approcciu sequenziale
L'urdinamentu di u vostru manuale d'utilizatore deve esse disposti in l'ordine sequenziale necessariu per finisce u travagliu in manu. Lista ogni passu per principià. Allora, fate un sforzu per fà l'assignazione mentre aderiscenu à i passi precisi chì avete delineatu in l'ordine datu. Quandu si passa per a vostra lista originale, hè pussibule, forse ancu prubabile, chì truverete qualsiasi stages chì mancanu. Inoltre, pudete truvà chì qualcosa chì una volta hà cridutu chì era un compitu unicu hà da esse divisu in parechje attività per a chiarezza.
Assicuratevi di avè specificatu un risultatu chjaru per ogni passu sequenziale chì avete attribuitu prima di passà à a fase successiva di scrive una guida d'utilizatore. Prima di passà à u prossimu livellu, i lettori anu da esse cumplettamente chjaru di ciò chì volenu realizatu è cumu si deve esse. - Mappa di viaghju di l'utilizatori
Capisce cumu i vostri cunsumatori pensanu à aduprà u vostru pruduttu è rende simplice per elli à fà cusì sò i scopi di pruduce una guida d'utilizatore. Duvete mette in u sforzu per capisce u prublema chì u cunsumadore prova di risolve o l'ughjettu chì cercanu di rializà utilizendu a vostra suluzione, è cumu si impegnanu cù a vostra attività. Pudete pianificà i passi necessarii per guidà u cliente à traversu u prucessu utilizendu sti dettagli per visualizà u so viaghju da u prublema à a suluzione. - Sceglite un Template
U compitu di scrive è sviluppà manuali d'utilizatore pò esse fattu assai più simplice di ciò chì puderebbe aspittà creendu una seria di mudelli. A vostra prucedura pò esse simplificata, è a coherenza diventerà un scopu assai più realistu.
In u vostru mudellu di manuale d'utilizatore, in più di definisce dettagli cum'è fonti (tipu è dimensione), esigenze di cuntrastu è schemi di culori, duvete ancu include i seguenti:- Zona attribuita per una introduzione
- Sottosezzioni è sezzioni distinti
- U vostru furmatu sceltu per trasmette una seria d'azzioni
- Note di prudenza è avvisi
- Zona attribuita per una cunclusione
- Scrivite un cuntenutu simplice è faciule da seguità
U materiale di u vostru manuale d'utilizatore deve esse u più simplice è simplice di capiscenu quant'è fattibile. Hè impurtante di pensà è analizà u furmatu è u cuntenutu per a clarità è a cunvenzione.
Assicuratevi chì ogni fase di u prucessu delinea solu un compitu è impiega una lingua più chjara è corta quant'è fattibile. Assicuratevi di mudificà bè u vostru testu finu à avè un manuale d'utilizatore chì cuntene solu l'infurmazioni chì hè veramente necessariu. - Avvicinà ogni utilizatore cum'è un principiante
Assumimu chì u lettore di u vostru manuale d'utilizatore ùn hà micca cunniscenza previa di u vostru pruduttu quandu crea. Scrivite cum'è si parlassi à un laico.
Ogni usu di gergo o lingua tecnica deve esse evitata. Naturalmente, ci saranu volte quandu deve esse evitata, ma queste deve esse l'eccezzioni assoluta. - Pruvate l'istruzzioni di u pruduttu cù l'utilizatori novi
A fase di prova di u prucessu di creazione manuale d'utilizatore hè cruciale. U sughjettu di a sperimentazione hà un impattu significativu nantu à u risultatu.
A prova deve esse fatta idealmente nantu à e persone chì ùn anu mai usatu u vostru pruduttu o vistu a documentazione. Cume si move à traversu u manuale di l'utilizatori, fighjate cum'è cum'è finiscinu u prucessu è arregistrate induve si fermanu. Allora, l'infurmazione deve esse aghjurnata in modu adattatu.
Solu l'aiutu di u manuale d'utilizatore deve esse necessariu per i vostri teste per uperà u pruduttu. Ùn deve micca bisognu di dumandà più assistenza. A Guida di l'URSS deve avè tutte l'infurmazioni chì necessitanu. - Custruisce u cuntenutu utilizendu un approcciu praticu
Ogni sforzu deve esse fattu per offre béton exampe descrizioni dettagliate di qualsiasi risultati chì l'utilizatori puderanu sperimentà dopu à seguità ogni passu in u manuale d'utilizatore. L'utilizatore deve esse cuscenti di qualsiasi feedback chì puderia avè da u pruduttu, è ancu di qualsiasi viste o sonu potenziale chì puderanu scontru in a strada. - Spiegà simbuli, icone è codici prima
Puderete bisognu di impiegà icone, simboli o codici mentre scrive un manuale d'utilizatore per aiutà à furnisce l'istruzzioni necessarii. Per prevene a cunfusione o a frustrazione di u lettore, hè cruciale per identificà queste quant'è prima pussibule in u vostru manuale d'utilizatore.
FAQ manuale d'usu
Chì sò esattamente i manuali d'utilizatore?
A documentazione di l'utilizatori hè infurmazione furnita in forma di manuali d'utilizatore o guide d'utilizatore è hè destinata à aiutà l'utilizatori finali à interagisce cù un pruduttu cù successu.
- Chì tipu di documentazione d'utilizatori ci sò?
A documentazione fisica, cum'è libretti o manuali, hè tradiziunale utilizata per offre a documentazione di l'utilizatori. In questi ghjorni, i manuali d'utilizatori sò pruduciuti è distribuiti più freti in digitale. - Cosa hè contenutu in i manuali d'usu?
Un manuale d'istruzzioni o una guida d'utilizatore usa un bonu disignu, una scrittura chjara è un focusu di risoluzione di prublemi. Deve avè una tabella di cuntenutu, aderisce à una ghjerarchia logica è flussu, è offre un cuntenutu accessibile. Inoltre, un bonu manuale d'utilizatore serà cercabile è piglià in contu l'utilizatori reviews. - Cumu hè fattu un documentu d'utilizatore?
Passi simplici pò esse usatu per sviluppà manuali d'utilizatore. L'ugettivi di a guida di l'utilizatori deve esse determinati prima, è deve esse sviluppata una strategia per permette a so realizazione. U manuale d'utilizatore deve esse pruvatu è aghjurnatu quantu necessariu prima di esse publicatu. Infine, hè impurtante di mantene a guida di l'utilizatori aghjurnata, fendu cambiamenti cum'è aghjurnamenti novi o edizioni sò aghjuntu.