Cum să scrieți manuale de utilizare clare și concise
Ce este un manual de utilizare?
Există diferite nume pentru un manual de utilizare. Documentele tehnice, manualele de întreținere și manualele de instrucțiuni sunt toate denumiri care se referă la același articol. Un manual de utilizare este creat pentru a ajuta clienții să utilizeze corect produsul sau serviciul dvs. sau să rezolve problemele care apar în timpul utilizării. Acestea pot fi disponibile în format tipărit, digital sau ambele formate.
Manualele de utilizare oferă utilizatorului final instrucțiuni cuprinzătoare, pas cu pas, precum și un anumit suport pentru probleme. Un cuprins ar trebui să fie prezent în fiecare manual de utilizare, deoarece acestea sunt materiale de referință mai degrabă decât cărți care ar trebui citite de la început până la sfârșit. Ar trebui să adăugați un tutorial de pornire rapidă sau de pornire în manualul dvs. de utilizare, astfel încât utilizatorii să se simtă în largul lor începând să utilizeze produsul.
tipuri de manuale de utilizare
Pentru o varietate de subiecte și obiective, pot fi produse manuale de utilizare. Iată câteva dintre posibilitățile tale, așa că hai să le analizăm.
- Manual de instructiuni
Un manual de instrucțiuni este un tip de ghid al utilizatorului care oferă instrucțiuni simple pentru utilizarea unui produs în modul în care a fost destinat să fie utilizat. - Manual de instruire
Acest tip de ghid de utilizare oferă o listă de îndrumări pentru finalizarea unei anumite sarcini, proiect sau muncă. - Manual de service
Manualele de service sunt ghiduri de utilizare care descriu cum să îngrijiți și să întrețineți o mașină sau echipament la diferite locuritages ale duratei sale de viață. - Manual de utilizare
Manualele de utilizare sunt publicații tehnice care explică modul de utilizare sau operare corectă a unui produs. - Manual de operare
Rolurile, sarcinile și procedurile specifice unei afaceri sau organizații sunt descrise în manualele de operare. - Manual de politici organizaționale
Un manual de politici organizaționale este documentația care definește politicile, practicile și cele mai bune practici ale unei companii. - Manualul procedurilor standard de operare (POS).
Utilizatorii beneficiază de instrucțiuni detaliate ale unui manual standard de proceduri de operare pentru realizarea procedurilor stabilite.
De ce are nevoie afacerea dvs. de manuale de utilizare?
Oamenii sunt mai bine echipați pentru a gestiona singuri problemele cu ajutorul unui manual de utilizare. Un manual de utilizare decent le poate oferi clienților dvs. instrumentele de care au nevoie pentru a obține rapid și eficient valoarea pe care și-o doresc de la produsul sau serviciul dvs. în cultura gratificației imediate de astăzi.
Un serviciu excelent pentru clienți trebuie completat cu manuale de utilizare. Scrierea unor manuale excelente de utilizare va oferi următorul avantajtageste pentru compania dvs.:
- Pentru a simplifica integrarea și formarea
Ghidurile de utilizare bine scrise pot simplifica procedurile de integrare și instruire. Este corect, prin dezvoltarea și implementarea manualelor de utilizare de top, atât angajații dvs., cât și consumatorii au de câștigat.
Compania dvs. poate folosi ghidurile de utilizare pentru a-i ajuta pe noii angajați să treacă prin unele dintre procesele și sistemele care fac parte din noile lor roluri, mai degrabă decât să organizeze doar sesiuni dificile de instruire în persoană, care au timp și cheltuieli financiare semnificative. Deoarece angajații pot învăța în timp ce își îndeplinesc sarcinile legate de pozițiile lor, datorită ghidurilor de utilizare, pot fi mai puține ore pierdute în timpul îmbarcării. - Pentru a reduce cheltuielile de suport
Ghidurile de utilizare sunt o completare excelentă la eforturile dumneavoastră de asistență pentru clienți pentru consumator, dar servesc și proprietarului afacerii ca o componentă a sistemului de asistență pentru clienți.
Clienții sunt mai probabil să găsească soluții imediat și este mai puțin probabil să fie nevoie să contacteze un tehnician sau un reprezentant pentru asistență specializată atunci când le oferiți acces rapid la un ghid al utilizatorului care poate fi căutat. - Pentru a economisi timp
Atât clienții, cât și angajații dvs., de la personalul entry-level la management, pot economisi timp utilizând manualele de utilizare. Atunci când manualele de utilizare sunt disponibile pentru clienții dvs., aceștia nu vor trebui să piardă timpul încercând să găsească informații despre cum să utilizeze un produs, deoarece vor avea acces direct la acele informații imediat.
Atunci când angajații tăi sunt echipați cu manuale de utilizare utile, ei nu trebuie să piardă timpul căutând soluții în mod independent sau să monopolizeze atenția colegilor și managerilor lor cu întrebări, deoarece au acces la soluțiile chiar în manualul lor de utilizare! - Pentru a minimiza răspunderea
O abordare pentru a demonstra că ați testat produsul în detaliu și că știți cum să-l utilizați în siguranță este să scrieți și să distribuiți manuale de utilizare. Acest lucru poate reduce semnificativ orice obligații legate de producerea de ceva pentru publicul larg.
Avertismentele și măsurile de precauție de siguranță notate și puse la dispoziția utilizatorilor printr-un ghid al utilizatorului este o modalitate eficientă (deși nu sigură) de a evita problemele legale legate de răniri sau alte daune cauzate de utilizarea greșită, dacă produsul pe care îl vindeți ar putea fi periculos pentru utilizatori (gândiți-vă că încălzitoare, scule electrice etc.).
Ce componente alcătuiesc cele mai bune manuale de utilizare?
Există câteva bune practici pentru documentația utilizatorului final la care trebuie să adere, indiferent de ce, chiar dacă fiecare produs este unic și va avea nevoie de componente distincte pentru a genera o documentație cu adevărat excelentă pentru utilizator.
- Limbajul simplu
Nimic nu-ți va irita mai mult clienții – în afară de a nu oferi unul – decât descoperirea manualului lor de utilizare este plin de jargon și limbaj greu de înțeles. Instrucțiunile dvs. de utilizator sunt dificil de utilizat din cauza acestor opțiuni de limbă, care, de asemenea, nu promovează un serviciu remarcabil pentru clienți. Asigurarea că scrieți pentru utilizator, nu pentru dezvoltator, este o componentă esențială a creării de ghiduri excelente pentru utilizator. Nu presupuneți că utilizatorul final știe sau este familiarizat cu ceva. Acronimele, jargonul și terminologia de birou îi vor face pe clienții tăi să se simtă prost informați, frustrați și nepregătiți. Punctul favorabil pentru producerea unui manual de utilizare este găsirea unui echilibru între a nu scrie ca și cum consumatorii tăi ar fi copii (cu excepția cazului în care, desigur, sunt!) și a le oferi ajutorul suplimentar de care au nevoie pentru a înțelege complet cum să folosească produsul, într-un mod simplu. limbă. - Simplitate
Scrierea unui manual de utilizare necesită păstrarea lucrurilor simple. Acest concept ar trebui să se reflecte atât în conținut, cât și în design. Dacă vă supraîncărcați documentația cu imagini complicate și pasaje lungi de text, aceasta va părea prea sofisticată și greu de înțeles. Este posibil ca acest tip de manual de utilizare să-ți intimideze utilizatorul și să-l determine să apeleze linia de asistență, mai degrabă decât să încerce să-și dea seama singuri problema. - Imagini vizuale
Maxima „Arată, nu spune” este o piatră de temelie a scrierii manuale de utilizare. Capturile de ecran adnotate, filmele și alt conținut vizual sunt extrem de utile în înțelegerea conceptelor. De multe ori este mult mai util să vezi ceva în acțiune decât să citești despre el. Elementele vizuale nu numai că rup pasajele lungi de text, dar reduc și cantitatea de text din manualele de utilizare care poate fi înfricoșătoare. S-a demonstrat că oamenii rețin informațiile vizuale cu 7% mai repede decât informațiile scrise. Într-un studiu Techsmith, s-a arătat, de asemenea, că 67% dintre oameni au îndeplinit sarcini mai eficient atunci când li s-au primit instrucțiuni care includeau capturi de ecran adnotate, mai degrabă decât numai cuvinte pentru a transmite informații. - Concentrați-vă pe problema de rezolvat
Este foarte probabil ca cineva să fi cumpărat produsul dvs. pentru a rezolva o problemă. Este esențial să rămâneți concentrat pe această problemă atunci când redactați manualul de utilizare care va fi inclus cu produsul. În loc să enumerați și să discutați toate caracteristicile oferite de produsul dvs. sau elementele de design interesante pe care le-ați încorporat, informați utilizatorii despre acestea într-un mod care facilitează utilizarea produsului. Puneți problema rezolvată în contextul caracteristicilor și beneficiilor produsului dvs. atunci când le descrieți. - Flux logic și ierarhie
Pentru a arăta utilizatorului ceea ce va învăța din fiecare secțiune a manualului dvs. de utilizare, utilizați anteturi și subtitluri care urmează o structură ierarhică clară. Pentru a vă conduce fără efort clienții prin tot ce trebuie să știe de la început până la sfârșit, ierarhia pe care o alegeți ar trebui să urmeze un flux logic. Asigurați-vă că începeți cu elementele fundamentale și includeți o progresie logică către caracteristicile mai sofisticate ale produsului dvs. - Lista de conținut
Ghidul dumneavoastră de utilizare va fi cel mai util pentru cititori dacă începe cu un cuprins. Fără a fi nevoie să caute multe pagini de informații care nu au legătură cu problema actuală cu care se confruntă, este o abordare familiară pentru cineva să exploreze rapid și ușor un document. - Faceți-l căutabil
Chiar dacă ați putea tipări manualele de utilizare, este probabil ca documentația digitală să fie prioritatea dvs. principală. Este foarte probabil ca manualele dvs. de utilizare să fie utilizate cel mai frecvent în format digital într-o lume în care majoritatea oamenilor au un smartphone la ei în permanență. Adăugarea unei funcții de căutare la manualele digitale de utilizare va promova o ușurință încântătoare de utilizare pentru utilizatorii care doresc să rezolve o problemă prin accesarea acesteia, similar cu modul în care un cuprins servește pentru a direcționa utilizatorii către locul potrivit într-un document tipărit. - Accesibilitate
Este posibil ca unele dintre persoanele care au nevoie de manualul de utilizare să beneficieze de asistență suplimentară pentru a se asigura că acesta funcționează corect. Indiferent dacă sunt impuse de lege, cerințele de accesibilitate sunt, în general, o bună practică. Menținerea cerințelor de accesibilitate în manualele dvs. de utilizare este doar o practică excelentă de afaceri. Proiectarea ghidurilor utilizatorului cu conținut care este accesibil pentru utilizatorii care ar putea avea provocări vizuale, auditive sau cognitive este crucială. - Bine proiectat
Luați în considerare publicul atunci când vă creați ghidurile de utilizare. Vor fi mult mai înclinați să-l folosească în mod eficient dacă faceți ceva la care le place să se uite! Evitați să utilizați blocuri de text lungi și oferiți mult spațiu alb. Combinarea acestor două caracteristici poate ajuta consumatorii să pară mai puțin înspăimântători și poate face ca învățarea a ceva nou să pară mai degrabă incitantă decât amenințătoare. Abordarea „arată, nu spune” pe care am descris-o mai devreme se aplică și aici. Atât pentru manualele de utilizare tipărite, cât și pentru cele digitale, adăugarea de imagini și fotografii la text este o alternativă grozavă. Pentru manualele digitale de utilizare, videoclipurile și GIF-urile oferă interes și un element util. Dacă compania ta are un ghid de stil, designul tău ar trebui să-l urmeze; în caz contrar, dacă operați fără unul, este esențial să păstrați ghidul de utilizare consecvent. Fonturile și schemele de culori utilizate în toată lucrarea și, în mod ideal, în toate ghidurile de utilizare, ar trebui să fie consecvente. - Comentarii de la clienți reali sau de la testeri beta
Nu veți putea determina dacă ghidurile de utilizare pe care le-ați pregătit au sau nu cât mai mult succes posibil până când nu veți căuta și asculta feedback de la persoanele care vor folosi efectiv produsul dvs. Ghidurile de utilizare pe care le dezvoltați pentru produsul dvs. ar trebui să țină cont de problemele pe care le au oamenii cu acesta. S-ar putea să înveți ceva care pare extrem de evident, dar există șanse mult mai mari să înveți ceva care te va ajuta să înțelegi nevoile clienților pe care încerci să-i atingi.
Cum scriu un manual de utilizare?
Realizarea unui manual de utilizare este o sarcină crucială care poate avea un impact mare atât asupra companiei dvs., cât și asupra consumatorilor pe care doriți să îi serviți. Am simplificat procesul de dezvoltare a unui manual de utilizare, astfel încât să puteți urmări cu ușurință, deoarece poate fi copleșitor.
- Identificați utilizatorii
Găsirea destinatarului comunicării dvs. este un pas inițial esențial, la fel ca în orice altă comunicare pe care o generați. Publicul vizat de manualul dvs. de utilizare vă va ajuta să decideți asupra unor probleme precum tonul, nivelul de detaliu pe care trebuie să îl furnizați și cum să furnizați conținutul. Scrierea unui ghid de utilizare pentru utilizatorul final al produsului dvs. este semnificativ diferită de scrierea unuia pentru un inginer tehnologic. Primul pas este să vă determinați publicul. - Concentrați-vă pe problemă
Manualele de utilizare sunt create pentru a ajuta la rezolvarea problemelor sau pentru a instrui pe cineva cum să facă ceva nou. Trebuie să determinați cu exactitate ce are scopul de a face manualul dvs. de utilizare și să vă asigurați că vă mențineți această concentrare.
Poate fi tentant să extindeți subiectul și să discutați numeroase caracteristici sau aplicații pentru produsul dvs. Acest lucru poate frustra utilizatorii și poate duce la apeluri către linia dvs. de asistență pentru clienți prin opunerea răspunsului autentic de care au nevoie.
Dacă clientul dvs. este un consumator care învață cum să folosească produsul sau un tehnician care trebuie să-l repare, concentrați-vă asupra soluției precise de care au nevoie. - Folosiți o abordare secvenţială
Instrucțiunile manualului dvs. de utilizare ar trebui să fie așezate în ordinea succesivă necesară pentru a finaliza lucrarea la îndemână. Enumerați fiecare pas pentru a începe. Apoi, faceți un efort pentru a face sarcina în timp ce respectați pașii precisi pe care i-ați subliniat în ordinea dată. Pe măsură ce parcurgeți lista originală, este posibil, poate chiar probabil, să găsiți orice stagsunt care lipsesc. În plus, s-ar putea să descoperi că ceva despre care credeai cândva că este o singură sarcină trebuie de fapt împărțit în mai multe activități, de dragul clarității.
Asigurați-vă că ați specificat un rezultat clar pentru fiecare pas secvenţial pe care l-ați alocat înainte de a trece la următoarea fază de scriere a unui ghid al utilizatorului. Înainte de a trece la nivelul următor, cititorii ar trebui să fie complet clar despre ceea ce doresc să se realizeze și cum ar trebui să pară. - Hartă călătoria utilizatorului
Înțelegerea modului în care intenționează consumatorii să vă folosească produsul și simplificarea acestora sunt obiectivele elaborării unui ghid de utilizare. Trebuie să depuneți efort pentru a înțelege problema pe care consumatorul încearcă să o rezolve sau obiectivul pe care încearcă să-l atingă utilizând soluția dvs., precum și modul în care se implică în afacerea dvs. Puteți planifica pașii necesari pentru a ghida clientul prin proces folosind aceste detalii pentru a-și vizualiza călătoria de la problemă la soluție. - Alegeți un șablon
Sarcina de a scrie și dezvolta manuale de utilizare poate fi simplificată mult mai mult decât v-ați aștepta prin crearea unei serii de șabloane. Procedura dumneavoastră poate fi simplificată, iar consecvența ar deveni un obiectiv mult mai realist.
În șablonul manualului de utilizare, pe lângă definirea detaliilor precum fonturile (tip și dimensiune), cerințele de contrast și schemele de culori, ar trebui să includeți și următoarele:- Zona alocată pentru o introducere
- Subsecțiuni și secțiuni distincte
- Formatul ales de dvs. pentru transmiterea unei serii de acțiuni
- Note de precauție și avertismente
- Zona alocată pentru o concluzie
- Scrieți conținut simplu și ușor de urmărit
Materialul manualului dvs. de utilizare ar trebui să fie cât mai simplu și simplu de înțeles pe cât posibil. Este important să vă gândiți și să analizați formatul și conținutul pentru claritate și comoditate.
Asigurați-vă că fiecare fază a procesului conturează o singură sarcină și folosește un limbaj cât mai clar și scurt posibil. Asigurați-vă că modificați corect textul până când aveți un manual de utilizare care conține doar informațiile care sunt cu adevărat necesare. - Abordați fiecare utilizator ca pe un novice
Să presupunem că cititorul manualului dumneavoastră de utilizare nu are cunoștințe anterioare despre produsul dumneavoastră atunci când îl creează. Scrie ca și cum ai vorbi cu un neprofesionist.
Ar trebui evitată orice utilizare a jargonului sau a limbajului tehnic. Desigur, vor exista momente când trebuie evitată, dar acestea ar trebui să fie excepția absolută. - Testați instrucțiunile produsului cu utilizatorii începători
Faza de testare a procesului de creare a manualului de utilizare este crucială. Subiectul experimentului are un impact semnificativ asupra rezultatului.
În mod ideal, testarea ar trebui să fie efectuată pe persoane care nu au folosit niciodată produsul dvs. sau care nu au văzut documentația. Pe măsură ce parcurgeți manualul de utilizare, urmăriți-le când termină procesul și înregistrați unde se blochează. Apoi, informațiile ar trebui actualizate în mod corespunzător.
Numai ajutorul manualului de utilizare ar trebui să fie necesar pentru ca testerii dumneavoastră să opereze produsul. Nu ar trebui să ceară mai multă asistență. Ghidul URSS ar trebui să aibă toate informațiile de care au nevoie. - Creați conținut folosind o abordare practică
Ar trebui depus toate eforturile pentru a oferi exampfișiere și descrieri detaliate ale oricăror rezultate pe care utilizatorii le-ar putea experimenta după ce au urmat fiecare pas din manualul de utilizare. Utilizatorul ar trebui să fie conștient de orice feedback pe care l-ar putea primi de la produs, precum și de eventualele imagini sau sunete pe care le-ar putea întâlni pe parcurs. - Explicați devreme simbolurile, pictogramele și codurile
Este posibil să fie necesar să utilizați pictograme, simboluri sau coduri în timp ce scrieți un manual de utilizare pentru a vă ajuta să furnizați instrucțiunile necesare. Pentru a preveni confuzia sau frustrarea cititorilor, este esențial să le identificați cât mai devreme posibil în manualul de utilizare.
Întrebări frecvente despre manualul de utilizare
Ce sunt mai exact manualele de utilizare?
Documentația utilizatorului este informații furnizate sub formă de manuale de utilizare sau ghiduri de utilizare și are rolul de a ajuta utilizatorii finali să interacționeze cu succes cu un produs.
- Ce fel de documentație pentru utilizator există?
Documentația fizică, cum ar fi broșurile sau manualele, a fost folosită în mod tradițional pentru a oferi documentație pentru utilizatori. În zilele noastre, manualele de utilizare sunt produse și distribuite mai frecvent digital. - Ce este conținut în manualele de utilizare?
Un manual de instrucțiuni sau un ghid al utilizatorului utilizează un design bun, o scriere clară și un accent pe rezolvarea problemelor. Trebuie să am un cuprins, să adere la o ierarhie și un flux logic și să ofer conținut care este accesibil. În plus, un manual de utilizare bun va putea fi căutat și va ține cont de utilizatorulviews. - Cum se face un document de utilizator?
Pași simpli pot fi utilizați pentru a dezvolta manuale de utilizare. Obiectivele ghidului utilizatorului trebuie mai întâi determinate și trebuie dezvoltată o strategie care să permită realizarea lor. Manualul de utilizare trebuie testat și actualizat după cum este necesar înainte de a fi publicat. În cele din urmă, este important să păstrați ghidul utilizatorului actualizat, făcând modificări pe măsură ce se adaugă noi actualizări sau ediții.