Cum să scrieți un manual de utilizare a software-ului: Ghidul final (inclusiv un șablon)

Nu sunteți sigur cum să scrieți un manual de utilizare a software-ului pentru produsul dvs.?

Dacă doriți să vă ajutați utilizatorii să obțină cea mai mare valoare de la produsul dvs. în cel mai eficient mod posibil, crearea unui manual de utilizare a software-ului de calitate este un loc minunat pentru a începe.

Oferindu-le utilizatorilor conținutul de care au nevoie pentru a învăța și a depana singuri produsul dvs., îi puteți ajuta să aibă succes fără ca aceștia să fie nevoiți să apeleze la canalele dvs. de asistență umană.

Acest lucru nu doar ușurează lucrurile pentru utilizatorii dvs., dar poate și reduce cererile de asistență la afacerea dvs., ceea ce vă economisește timp și bani.

Deci, cum puteți crea manualul de utilizare al software-ului perfect pentru utilizatorii dvs.? Acesta este scopul acestui ghid.

Pentru a vă ajuta să vă puneți în funcțiune, iată tot ce vom acoperi în această postare:

• Ce este un manual de utilizare a unui software
• Cum să scrieți un manual de utilizare a software-ului în patru pași, inclusiv un șablon de manual de utilizare a software-ului
• Cele mai bune practici pentru crearea de conținut de înaltă calitate pentru manualul de utilizare

Să pătrundem!

Ce este un manual de utilizare a software-ului?

Un manual de utilizare a software-ului este o documentație care oferă informații despre cum să utilizați și să gestionați aplicația sau produsul software.

Manualul de utilizare al software-ului poate include ghiduri introductive, instrucțiuni, glosare, sfaturi de depanare și alte tipuri similare de conținut.

Practic, include toate informațiile de care utilizatorii dvs. au nevoie pentru a obține valoare din software-ul dvs.

De obicei, va începe cu pașii de instalare, apoi va acoperi o prezentare generală a interfeței și a modului de utilizare a diferitelor funcții, apoi va cerceta depanarea și întrebările frecvente, dacă este necesar. Din nou, vom împărtăși mai jos un șablon de manual de utilizare a software-ului mai detaliat.

Pentru a vedea un exemplu de manual de utilizare a software-ului, puteți consulta Manualul de utilizare Forklift 3, care trece direct în explicația interfeței.

Pentru un alt exemplu, puteți să vă uitați la conținutul Noțiuni introductive de la Slack, care, de asemenea, trece direct în explicarea interfeței Slack.

De ce este important să creați un manual de utilizare a software-ului?

Există două mari motive pentru a crea un manual de utilizare a software-ului pentru produsul dvs.:

1. Experiență îmbunătățită a utilizatorului – făcând utilizatorilor să învețe mai ușor cum să folosească software-ul dvs. și să maximizeze valoarea pe care o primesc din software-ul dvs., utilizatorii dvs. vor avea experiențe mai bune.
2. Povara de asistență redusă – oferind utilizatorilor posibilitatea de a-și rezolva propriile probleme, puteți reduce sarcina pe canalele dumneavoastră de asistență umană. Acest lucru este valabil mai ales dacă combinați manualul de utilizare cu alte tipuri de conținut de asistență, cum ar fi o bază de cunoștințe și/sau întrebări frecvente (FAQs).

Cum să scrieți un manual de utilizare a software-ului în patru pași

Acum, să intrăm în ghidul general pas cu pas despre cum să scrieți un manual de utilizare a software-ului. În secțiunea următoare, vom trece peste câteva dintre cele mai bune practici pentru conținutul real din manualul de utilizare.

Dacă sunteți interesat de o privire mai generală asupra acestor subiecte, avem și un ghid despre cum să creați orice tip de manual de utilizare.

1. Planificați structura manualului dumneavoastră de utilizare a software-ului

Înainte de a începe să creați orice conținut pentru manualul dvs., mai întâi veți dori să mapați corect structura manualului.

Pentru a face manualul cât mai cuprinzător posibil, ați putea dori să reuniți mai multe părți interesate cheie pentru a vă ajuta să faceți acest lucru.

De exemplu, aceasta ar putea include succesul clienților, vânzările și așa mai departe - oricine are cunoștințe despre cum să îi ajute pe utilizatori să obțină cât mai multă valoare posibil din produs. În unele cazuri, s-ar putea să fie necesar să aduceți mai mult personal tehnic pentru a vă ajuta cu detalii mai avansate.

Desigur, dacă derulezi un proiect solo, vei purta și tu toate aceste pălării. Aceasta este bucuria de a fi fondator solo.

Odată ce aveți deținătorii de cunoștințe relevanți la locul lor, puteți construi schița manualului dvs. de utilizare.

Pentru un șablon brut de manual de utilizare a software-ului, puteți urma ceva de genul acesta...

1. Cuprins – enumerați diferitele secțiuni din manualul de utilizare, astfel încât utilizatorii să știe la ce să se aștepte.
2. Introducere – explicați scopul manualului dumneavoastră de utilizare a software-ului.
3. Cerințe de sistem – detaliați orice cerințe specifice de care oamenii au nevoie pentru a utiliza software-ul dvs., cum ar fi specificațiile hardware, sistemul de operare etc.
4. Instrucțiuni de instalare – acoperă modul în care utilizatorul poate instala software-ul.
5. Prezentare generală a interfeței utilizator – oferiți o imagine de ansamblu la nivel înalt a interfeței.
6. Cum să utilizați anumite funcții – creați o secțiune pentru fiecare caracteristică de bază care arată utilizatorilor cum funcționează.
7. Întrebări frecvente – acoperiți câteva întrebări frecvente pe care le-ar putea avea un utilizator.
8. Depanare – partajați sfaturi de depanare.
9. Glosar – dacă software-ul dumneavoastră are o terminologie specifică, este posibil să doriți să adăugați un glosar la sfârșitul manualului de utilizare al software-ului.
10. Detalii de contact pentru asistență – explicați modul în care utilizatorii pot contacta asistența dacă au nevoie de ajutor suplimentar. Doriți să păstrați acest lucru la sfârșit, astfel încât utilizatorii să încerce să se ajute singuri înainte de a contacta asistență.

Nu trebuie să urmați exact acest șablon de manual de utilizare al software-ului – este doar un punct de plecare pentru a vă oferi o idee despre ceea ce ați putea dori să includeți.

2. Creați conținutul manualului utilizatorului software

Odată ce aveți schița dvs., sunteți gata să începeți să creați conținutul manualului de utilizare al software-ului.

Cea mai mare parte a conținutului dvs. va fi text, dar nu uitați să includeți și imagini relevante, GIF-uri și videoclipuri.

Deși acest pas va dura probabil cel mai mult timp, păstrăm această secțiune pe scurt pentru moment , deoarece, în secțiunea următoare, vom împărtăși câteva dintre cele mai bune practici ale manualelor de utilizare a software-ului pentru a vă ajuta echipa să creeze conținut eficient de manual de utilizare.

Cine vă scrie conținutul va depinde de dimensiunea organizației dvs. și de complexitatea produsului dvs. Dacă nu aveți un scriitor tehnic dedicat, poate fi necesar să atribuiți conținutul echipei de succes a clienților sau echipei tehnice, în funcție de complexitatea software-ului dvs.

Sau, dacă sunteți un fondator solo, probabil că veți fi cea mai bună persoană care să vă scrie conținutul manual, deoarece aveți cea mai profundă înțelegere a conținutului dvs. Puteți angaja oricând un editor care să vă ajute să vă îmbunătățiți primul proiect.

3. Publicați manualul de utilizare al software-ului

Odată ce aveți conținutul pentru manualul de utilizare al software-ului, trebuie să vă publicați manualul într-un mod care să le permită utilizatorilor să-l consume cu ușurință.

Majoritatea bazei de cunoștințe sau a software-ului de documentare ar trebui să funcționeze bine pentru un manual de utilizare a software-ului, deși puteți oricând să vă codificați propria soluție dacă vă simțiți prea limitat. Unele companii publică și o versiune PDF a manualului de utilizare, pe lângă versiunea web.

Pentru a vedea câteva opțiuni excelente pentru publicarea versiunii web a manualului de utilizare a software-ului, puteți consulta listele noastre cu cele mai bune baze de cunoștințe software și cu cele mai bune instrumente de documentare.

Dacă sunteți în căutarea unui software manual de utilizare care vă oferă o listă solidă de caracteristici, proprietate deplină asupra conținutului dvs. și flexibilitatea de a personaliza lucrurile în funcție de nevoile dvs., puteți utiliza pluginul nostru WordPress Heroic Knowledge Base.

Heroic Knowledge Base este un software open-source care extinde sistemul de gestionare a conținutului (CMS) WordPress, în mod similar, cu toate funcționalitățile de care aveți nevoie pentru a vă publica manualul de utilizare al software-ului.

Veți avea proprietatea deplină asupra platformei dvs., plus flexibilitatea de a ajusta fiecare element după cum este necesar. Dar, în același timp, Heroic Knowledge Base include în continuare funcționalități încorporate pentru toate caracteristicile importante de care are nevoie manualul de utilizare a software-ului:

• Organizarea articolelor – puteți organiza articolele din manualul software folosind categorii. De exemplu, puteți avea diferite categorii pentru „Instalare”, „Interfață”, „Utilizarea funcțiilor”, „Depanare” și așa mai departe.
• Funcții de descoperire de conținut – pentru a ajuta utilizatorii să găsească conținut relevant cât mai repede posibil, Heroic Knowledge Base include funcții utile de descoperire a conținutului, cum ar fi sugestii de căutare în timp real, cuprins automat și multe altele.
• Sistem de feedback al utilizatorilor – utilizatorii pot împărtăși feedback despre utilitatea fiecărui articol, ceea ce vă permite să știți ce faceți bine (și unde trebuie să vă îmbunătățiți).
• Analize detaliate – puteți urmări ce articole obțin cele mai multe vizionări, ce articole duc la cele mai multe solicitări de asistență umană, ce termeni caută utilizatorii, ce căutări nu returnează niciun rezultat și multe altele.

4. Actualizați manualul de utilizare a software-ului pe baza feedback-ului și modificărilor

Crearea unui manual de utilizare a software-ului de calitate nu este un lucru „o dată și făcut”. Odată ce ați publicat manualul, este important să desemnați în continuare părțile interesate cheie să actualizeze și să revizuiască manualul, după cum este necesar.

În unele cazuri, aceste actualizări ar putea fi necesare de o modificare a software-ului dumneavoastră. De exemplu, dacă adăugați o funcție nouă sau modificați interfața software-ului, va trebui să actualizați manualul de utilizare pentru a ține cont de aceste modificări.

În alte cazuri, aceste actualizări ar putea apărea din feedbackul utilizatorilor. De exemplu, dacă observați că utilizatorii sunt confuzi de un anumit articol, puteți actualiza acel articol pentru a-l face mai util.

Sau, dacă observați că utilizatorii caută un subiect care nu există în manualul de utilizare al software-ului, este posibil să fie necesar să creați un articol nou pentru a acoperi subiectul respectiv.

Publicarea manualului de utilizare cu un instrument precum Heroic Knowledge Base vă va permite să urmăriți cu ușurință aceste tipuri de analize, astfel încât să puteți monitoriza și îmbunătăți conținutul manualului de utilizare.

Cele mai bune practici pentru scrierea manualului de utilizare a software-ului

Acum că înțelegeți procesul de bază al modului de a scrie un manual de utilizare a software-ului, să trecem peste câteva dintre cele mai bune practici pentru crearea de conținut eficient manual de utilizare.

Înțelegeți cine este publicul dvs

Dacă doriți să creați conținut util manual de utilizare, este esențial să știți pentru cine scrieți:

• De unde provin utilizatorii dvs.
• Ce încearcă să realizeze cu software-ul tău.
• Ce puncte dureroase se confruntă.
• Nivelul lor general de cunoștințe despre industria dvs. și/sau orice domenii tehnice relevante.
• Pentru ce companie lucrează (sau dacă sunt utilizatori individuali).
• etc.

De exemplu, să presupunem că software-ul dvs. se ocupă de Salesforce. Dacă utilizatorii dvs. țintă sunt administratori Salesforce cu experiență, conținutul dvs. ar arăta mult diferit decât dacă utilizatorii țintă ar fi înșiși agenții de vânzări.

Probabil că veți avea deja o bună înțelegere a utilizatorilor țintă din munca dvs. existentă. Cu toate acestea, dacă nu sunteți sigur, puteți utiliza personalitatea clienților, sondaje și interviuri pentru a obține o înțelegere mai profundă.

Utilizați o structură și o organizare logică

Am atins acest lucru în primul pas al secțiunii anterioare, dar este important să vă organizați manualul de utilizare într-un mod optim pentru ca utilizatorii să obțină mai ușor valoare din conținutul dvs.

Există diferite moduri prin care vă puteți organiza manualul de utilizare și puteți utiliza mai multe abordări în diferite secțiuni:

• Experiență liniară – vă puteți organiza manualul în modul în care utilizatorii vor experimenta lucrurile. De exemplu, puteți începe cu „Instalare” ca primă secțiune și apoi treceți la prima acțiune după instalare în secțiunea următoare.
• Funcție – vă puteți organiza conținutul manual pe baza diferitelor caracteristici ale software-ului dvs.
• Depanare – puteți colecta pașii comuni de depanare într-un singur loc.

Din nou, este foarte bine să utilizați mai multe abordări în manualul dvs. De exemplu, puteți începe prin a organiza lucrurile într-o manieră liniară pentru procesul de instalare.

Dar odată ce ați acoperit instalarea și utilizatorii pot începe să aplice software-ul dvs. în moduri diferite, puteți trece la o abordare organizațională bazată pe caracteristici.

Păstrați-vă scrierea simplă și consecventă

Pentru ca manualul de utilizare al software-ului să fie cât mai accesibil posibil, este important să vă mențineți scrisul cât mai simplu posibil.

Iată câteva lucruri de care trebuie să ții cont pentru ca acest lucru să se întâmple:

• Nu folosiți jargon sau cuvinte confuze – nu toți utilizatorii dvs. vor avea aceleași cunoștințe când vine vorba de industria dvs. și/sau limba produsului dvs., așa că este important să evitați jargonul tehnic inutil și vocabularul confuz. Vă puteți testa conținutul cu instrumente precum testul Flesch Reading Ease pentru a găsi probleme.
• Evitați vocea pasivă - folosirea vocii pasive poate fi deosebit de confuză într-un manual de utilizare. De exemplu, în loc să utilizați o voce pasivă, cum ar fi „Salvarea unei copii a schiței dvs. poate fi făcută apăsând butonul Salvare schiță ”, este mai bine să utilizați o voce activă, cum ar fi „Apăsați butonul Salvare schiță pentru a salva o copie a schiței dvs. proiect."
• Folosiți propoziții scurte – împărțirea conținutului în propoziții scurte facilitează consumul și scanarea conținutului manual de utilizare pentru utilizatori. Ori de câte ori este posibil, evitați paragrafele lungi (AKA „pereți de text”).
• Rămâneți consecvent – ​​folosirea unei formulări și formatări consecvente va face mai ușor pentru utilizatori să înțeleagă manualul dvs. De exemplu, dacă folosiți întotdeauna o listă ordonată pentru a enumera pașii individuali dintr-o anumită sarcină, încercați să păstrați acea formatare în întregul manual de utilizare.
• Evitați problemele cu gramatica - asigurați-vă că nu aveți greșeli gramaticale care ar putea îngreuna înțelegerea manualului pentru utilizatori. Puteți verifica acest lucru folosind instrumente precum Grammarly și Hemingway.

Includeți imagini și videoclipuri acolo unde sunt utile

Deși conținutul text va sta la baza manualului dvs. de utilizare, este important să includeți și imagini și videoclipuri acolo unde are sens.

Zicala că „o imagine valorează cât o mie de cuvinte” ar putea fi un clișeu, dar poate fi cu siguranță adevărată atunci când încerci să explici cum pot folosi utilizatorii valoare din produsul tău software.

Pentru a explica conceptele din text, puteți adăuga imagini adnotate sau GIF-uri care demonstrează despre ce vorbiți.

De exemplu, Slack face o treabă grozavă de adnotare a imaginilor de introducere a interfeței.

Conținutul video poate fi util și pentru unii utilizatori. Cu toate acestea, ar trebui să aveți grijă să vă bazați exclusiv pe conținut video, deoarece nu este întotdeauna o modalitate optimă pentru utilizatori de a consuma conținut manual de software.

De exemplu, dacă un utilizator încearcă doar să depaneze un anumit detaliu, este de obicei mult mai ușor pentru el să găsească acel detaliu în conținutul text decât într-un videoclip.

Creați-vă manualul de utilizare a software-ului astăzi

Aceasta încheie ghidul nostru despre cum să scrieți un manual excelent de utilizare a software-ului, care vă va pregăti utilizatorii pentru succes.

Dacă doriți cel mai simplu mod de a publica manualul de utilizare a software-ului, puteți utiliza pluginul Heroic Knowledge Base pentru WordPress.

Heroic Knowledge Base este un plugin open-source care vă permite să utilizați CMS-ul WordPress pentru a vă crea propriul manual de utilizare a software-ului auto-găzduit, care este pe deplin sub controlul dumneavoastră.

În același timp, nu trebuie să sacrificați funcționalitatea, deoarece Heroic Knowledge Base oferă toate caracteristicile de care aveți nevoie pentru a crea un manual de utilizare excelent al software-ului. Aceste funcții includ sugestii de căutare live, organizarea categoriilor, colectarea feedback-ului utilizatorilor, analize și multe altele.

Dacă sunteți gata să începeți, cumpărați Heroic Knowledge Base astăzi și veți avea un manual de utilizare minunat în cel mai scurt timp.