Cum se creează un manual de utilizare: de la zero la erou (ghid complet)

Nu sunteți sigur cum să creați un manual de utilizare pentru a vă ajuta clienții să obțină mai multă valoare de pe produsul dvs.?

Un manual de utilizare este conținut care îi ajută pe clienții (sau angajații) să vă folosească produsul sau serviciul în mod eficient. De asemenea, s-ar putea să îl vedeți numit ghid de utilizare, manual de instrucțiuni, manual de produs și așa mai departe.

Dincolo de a vă ajuta clienții să vă folosească în mod eficient produsul, crearea unui manual de utilizare de înaltă calitate vă poate ajuta, de asemenea, să reduceți cererile de servicii și asistență pentru clienți, deoarece utilizatorii își pot rezolva problemele fără a contacta asistența.

În acest ghid detaliat, veți învăța cum să creați un manual de utilizare care să vă ajute clienții să obțină succes.

Pentru a face acest lucru, iată tot ce vom acoperi:

• Diferite tipuri de manuale de utilizare
• Unde să vă publicați manualul de utilizare
• Cum se creează un manual de utilizare

Să pătrundem!

Diferite tipuri de manuale de utilizare

Există diferite tipuri de manuale de utilizare, inclusiv conținut destinat clienților și conținut intern.

Înainte de a începe, este important să înțelegeți ce tip de manual doriți să creați, deoarece asta va afecta modul în care abordați conținutul.

Iată un rezumat rapid al diferitelor tipuri de manuale de utilizare:

• Manual de utilizare – un manual de utilizare clasic îi învață pe utilizatori cum să folosească un produs.
• Manual de instruire – un manual de instruire învață utilizatorii cum să îndeplinească o anumită sarcină sau să finalizeze o anumită lucrare.
• Manual de operare – un manual de operare este de obicei un manual intern care documentează operațiunile companiei dumneavoastră.
• Manual de service – un manual de service se concentrează pe învățarea utilizatorilor cum să întrețină corect un produs în diferite puncte ale ciclului de viață al produsului.
• Proceduri de operare standard (SOP) – SOP-urile sunt manuale interne care îi învață pe membrii organizației cum să finalizeze în mod corespunzător anumite procese „în modul corect”.

Pentru instrucțiunile de mai jos, ne preocupă mai ales crearea unui manual de utilizare destinat publicului. Cu toate acestea, principiile de bază de mai jos se vor aplica oricărui tip de manual de utilizare.

Unde să publicați manualul de utilizare

Unde vă publicați manualul de utilizare va depinde de tipul de manual de utilizare pe care îl creați.

Pentru manualele de utilizare adresate clienților, aproape întotdeauna veți dori să le publicați pe site-ul dvs. web. În acest fel, utilizatorii pot accesa manualul de oriunde.

În plus, publicarea conținutului manualului de utilizare pe web vă permite, de asemenea, să creați o experiență mai ușor de utilizat decât puteți cu un manual de utilizare fizic, cum ar fi adăugarea de cuprinsuri pe care se poate face clic și sugestii de căutare în timp real.

Cu toate acestea, pentru produsele fizice, este posibil să doriți să includeți și un manual de utilizare fizic ca însoțitor al manualului dvs. bazat pe web.

Pentru manualele de utilizare interne, de obicei, veți dori să le ascundeți pentru publicul.

O modalitate de a realiza acest lucru este de a le pune la dispoziție doar pe intranetul companiei. Cu toate acestea, având în vedere atât de mulți oameni care lucrează de acasă, acest lucru poate fi dificil de realizat, cu excepția cazului în care compania dvs. are propria sa configurație VPN.

În schimb, puteți lua în considerare protejarea prin parolă a conținutului, fie solicitând angajatului să se conecteze la un cont de utilizator, fie doar adăugând o parolă pentru a accesa pagina.

Pentru manualele de utilizator fizice, puteți utiliza un instrument dedicat de gestionare a cunoștințelor care vă va ajuta să publicați manuale mai complexe. Sau, pentru manuale de utilizare mai simple, puteți să scrieți în Google Docs și să publicați de acolo – colecția noastră de instrumente tehnice de scriere are câteva instrumente utile pentru a vă ușura viața.

Pentru a publica manualul de utilizare online, puteți utiliza majoritatea documentației sau a software-ului de bază de cunoștințe. Dacă doriți un instrument care să poată gestiona atât manualele de utilizare destinate publicului, cât și manualele interne, puteți lua în considerare pluginul open-source Heroic Knowledge Base pentru WordPress. Vom vorbi despre asta mai în profunzime în tutorial.

Iată un exemplu de manual de utilizare online din baza Heroic Knowledge (și despre Heroic Knowledge Base):

Apropo de tutorial...

Cum se creează un manual de utilizare în șase pași

Acum că aveți câteva informații de fundal, să vedem cum să creați un manual de utilizare, pornind de la zero și mergând până la un manual de utilizare finalizat.

1. Creați-vă personal(ele) utilizator

Înainte de a începe să creați orice conținut, doriți să înțelegeți pentru cine este conținutul, lucru pe care îl puteți realiza prin crearea de persoane de utilizator.

Probabil că aveți deja o idee bună despre clienții dvs., dar este util să scrieți acest lucru pentru a vă concentra cu adevărat eforturile.

De ce este acest lucru important?

Ei bine, iată un exemplu:

Există o mare diferență între crearea de conținut tehnic pentru inginerii mecanici și crearea de conținut tehnic pentru utilizatorii non-tehnici.

Pentru majoritatea produselor, diferențele nu vor fi atât de mari. Dar este totuși important să înțelegeți personajele clienților dvs., astfel încât să vă puteți asigura că manualul dvs. de utilizare are sens pentru persoanele care îl vor folosi efectiv.

2. Identificați problema(ele) cheie și obiectivul(ele)

Odată ce înțelegeți cine sunt clienții dvs., următorul pas este să înțelegeți ce încearcă aceștia să obțină cu manualul de utilizare pe care îl veți crea.

Adică, care este scopul final (sau obiectivele finale) ale persoanelor care vor citi acest manual?

Înțelegerea acestui lucru este importantă, deoarece scopul manualului dvs. ar trebui să fie de a vă ajuta utilizatorii să atingă acel obiectiv cât mai eficient posibil.

În unele cazuri, acest obiectiv final poate fi un lucru specific. De exemplu, dacă aveți un instrument de gestionare a rețelelor sociale, ar putea fi „programarea unei postări pe rețelele sociale”.

În altele, ar putea fi un obiectiv mai abstract, cum ar fi „îmbunătățirea proceselor noastre de management de proiect”.

Pentru produse mai mari, ar putea exista mai multe lucruri pe care utilizatorul încearcă să le realizeze, ceea ce ne conduce la următoarea secțiune.

3. Creați o structură logică și o ierarhie

Acum că înțelegeți cine sunt clienții dvs. și ce doresc să obțină, puteți începe să mapați structura pentru manualul dvs. de utilizare.

Doriți să creați o structură care să vă conducă utilizatorii de la „zero” la atingerea obiectivelor finale pe care le-ați enumerat în secțiunea anterioară.

Iată câteva sfaturi pentru a vă ajuta să faceți acest lucru:

1. Gândiți-vă la cum puteți ajuta clienții să înceapă să obțină valoare de pe produsul dvs. cât mai repede posibil.
2. Scoate-ți propriile cunoștințe personale din asta. În mod evident, știi multe despre produsul tău, dar clienții tăi nu vor avea acel nivel de cunoștințe de bază.
3. Asigurați-vă că acoperiți orice problemă obișnuită sau detalii confuze pe care le-ar putea întâlni clienții dvs. atunci când încearcă să vă folosească produsul. Acestea ar trebui abordate în mod logic în momentele în care clienții sunt cel mai probabil să întâmpine probleme.

4. Scrieți conținutul manualului dvs. de utilizare

După ce ți-ai mapat conținutul, ești gata să începi să scrii.

În funcție de dimensiunea produsului/organizației dvs., puteți scrie totul singur. Sau, poate fi necesar să colaborați cu alți membri ai echipei pentru a scrie conținutul.

Iată câteva dintre cele mai bune practici generale pentru manualul de utilizare pe care trebuie să le luați în considerare atunci când scrieți manualul de utilizare:

• Utilizați un șablon pentru a asigura o formatare consecventă . Crearea unui șablon formatat nu numai că vă accelerează munca, dar vă asigură și că fiecare articol din manual este în concordanță cu celelalte.
• Includeți elemente vizuale (imagini și videoclipuri) pentru a ajuta utilizatorii . O imagine bine adnotată sau GIF poate fi mai utilă decât instrucțiunile de text de sine stătătoare, indiferent cât de detaliat și complet este textul.
• Folosiți un limbaj simplu și evitați jargonul . Sau, când jargonul este complet inevitabil, asigurați-vă că îl explicați.
• Păstrați-l scurt și la obiect . Scopul dvs. cu un manual de utilizare ar trebui să fie să acoperiți pe deplin subiectul, dar în cât mai puține cuvinte posibil. Nu omite informații importante, ci tăiați fără milă orice conținut inutil.
• Folosiți marcatori și liste pentru instrucțiuni atunci când este posibil . Utilizarea unei liste numerotate sau marcate poate facilita utilizatorilor să țină evidența ghidului. Sau, dacă aveți nevoie de mai multe detalii decât permite o listă, puteți face fiecare pas propriul subtitlu.
• Utilizați vocea activă . Vocea pasivă poate fi deosebit de confuză pentru instrucțiunile dintr-un manual de utilizare. Este diferența dintre „Produsul poate fi pornit apăsând butonul roșu” și „Puteți porni produsul apăsând butonul roșu”. Ultimul exemplu (voce activă) este mai clar și facilitează introducerea cititorului în instrucțiuni.

În cele din urmă, este întotdeauna o idee bună să testați instrucțiunile din manualul de utilizare ca și cum ați fi un utilizator pentru prima dată.

Adică, odată ce ați scris un articol, întoarceți-vă și urmați efectiv acele instrucțiuni pas cu pas pentru a vă asigura că nu ați ratat nimic.

5. Publicați manualul de utilizare

Odată ce aveți conținutul dvs., ultimul pas pentru a fi difuzat este să vă publicați manualul de utilizare pentru a-l face ușor disponibil pentru clienții dvs.

Modul în care faceți acest lucru va depinde de tipul de produs pe care îl oferiți. De exemplu, este posibil să doriți să includeți o versiune fizică a manualului dvs. dacă expediați produse fizice.

Cu toate acestea, indiferent de tipul de produs pe care îl oferiți, veți dori să publicați manualul de utilizare online, astfel încât oamenii să-l găsească cu ușurință.

Pentru a vă ajuta să faceți acest lucru, puteți utiliza baza de cunoștințe/software de documentare.

De exemplu, cu pluginul WordPress Heroic Knowledge Base, vă puteți publica manualul de utilizare folosind software-ul WordPress open-source.

Această abordare open-source vă oferă proprietatea deplină și controlul asupra platformei dvs., oferind în același timp o mulțime de instrumente utile pentru a vă ajuta clienții să navigheze mai eficient în manualul dvs. de utilizare:

• Organizarea categoriilor – vă puteți organiza cu ușurință manualul de utilizare în categorii logice și puteți ordona acele categorii folosind drag and drop.
• Sugestii de căutare în timp real – dacă clienții doresc să treacă direct la un anumit tutorial, pot începe să introducă în căutare și să vadă sugestii de căutare live pe baza interogărilor lor.
• Cuprins automat – pluginul va genera automat un cuprins pe care se poate face clic pentru fiecare articol din manualul de utilizare, ceea ce îi ajută pe cititori să sară direct la secțiunea care este relevantă pentru ei.
• Înștiințări/formatare ușoare – puteți adăuga cu ușurință înștiințări și alte formatări pentru a atrage atenția asupra elementelor cheie din articolele dvs.
• Widget cu răspunsuri instantanee – pe lângă crearea unei pagini dedicate de manual de utilizare pe site-ul dvs., puteți adăuga și un widget cu răspunsuri instantanee care poate fi căutat, care le permite vizitatorilor să răsfoiască conținutul manualului de utilizare de oriunde pe site-ul dvs.

Dacă doriți să vedeți și mai multe opțiuni pentru software care să vă ajute să publicați un manual de utilizare, puteți citi postările noastre despre cel mai bun software de bază de cunoștințe și cele mai bune instrumente de documentare.

6. Actualizați și revizuiți manualul de utilizare după cum este necesar

Crearea unui manual de utilizare nu este un efort unic. În continuare, va trebui să acordați timp revizuirii și actualizarii conținutului dvs.

Există două motive principale pentru care ar putea fi necesar să actualizați manualul de utilizare:

1. Ați adăugat noi funcții la produsul dvs. sau ați modificat modul în care funcționează funcțiile/interfețele existente.
2. Doriți să vă îmbunătățiți conținutul manualului de utilizare pentru a-l face mai util.

Prima situație este evidentă – dacă vă schimbați produsul într-un fel, trebuie să actualizați manualul de utilizare pentru a ține cont de aceste modificări.

Cu toate acestea, este important să luați în considerare și a doua situație. Oricât de încercați, probabil că nu veți obține perfect fiecare articol din manualul de utilizare din prima zi.

Pentru a vă ajuta mai bine utilizatorii, veți dori să actualizați și să revizuiți conținutul manual cu performanțe scăzute pentru a-l face mai util.

Dacă vă publicați manualul de utilizare cu un instrument precum Heroic Knowledge Base, acesta include evaluări încorporate pentru utilitatea articolelor, astfel încât să puteți vedea cu ușurință ce articole trebuie îmbunătățite. Utilizatorii pot lăsa, de asemenea, feedback text despre articol, care vă poate indica anumite părți ale articolului care nu vă ajută atât de mult pe cât ar putea fi:

De asemenea, s-ar putea să lipsească articole pentru subiecte cu care utilizatorii au probleme. Pentru a vă ajuta să găsiți aceste subiecte lipsă, Heroic Knowledge Base include, de asemenea, analize de căutare încorporate, astfel încât să puteți urmări căutările care nu au niciun rezultat de subiect ( precum și căutările generale în general ):

Creați-vă manualul de utilizare astăzi

A învăța cum să creați un manual de utilizare este important dacă doriți să vă pregătiți clienții pentru succes.

Cu sfaturile și cele mai bune practici din această postare, acum ar trebui să aveți cunoștințele de care aveți nevoie pentru a începe să utilizați manualul de utilizare.

Pentru o modalitate ușoară de a publica manualul de utilizare online și de a vă ajuta clienții să navigheze în el, puteți utiliza WordPress și pluginul Heroic Knowledge Base.

Baza de cunoștințe eroică facilitează publicarea articolelor și organizarea lor după cum este necesar. În plus, clienții tăi pot profita de funcții utile, cum ar fi sugestii de căutare live, cuprins automat și multe altele.

Începeți astăzi și veți publica manualul de utilizare în cel mai scurt timp.

Dacă sunteți interesat să creați documentație pentru a îmbunătăți cunoștințele interne la afacerea dvs., ați putea fi, de asemenea, interesat de tutorialul nostru despre cum să publicați un manual de instruire pentru personalul dvs.