9 sfaturi pentru o documentare extraordinară pentru utilizator (cu exemple)

Documentația utilizatorului este o parte importantă a produsului global livrat clientului dumneavoastră. Ajută utilizatorii finali să aibă mai mult succes cu produsul sau serviciul dvs.

În trecut, documentația utilizatorului era oferită printr-un fișier de ajutor care era local pe computerul utilizatorului sau printr-un manual fizic sau o broșură. Acest lucru a însemnat că nu a putut fi actualizat sau schimbat cu ușurință și că furnizorii de software au primit foarte puține date despre modul în care a fost utilizat conținutul lor.

În zilele noastre, documentația pentru utilizatori este aproape întotdeauna oferită online, ceea ce i-a ajutat pe scriitorii tehnici să fie mai imaginativi în modul în care asistă utilizatorii. Aceștia pot colecta date, pot încerca diferite tehnici de învățare, pot repeta mai rapid și pot produce o experiență de conținut mai bogată pentru utilizatori.

Aici intervine această postare pe blog! eu

În această postare, vom explora ce puteți face pentru a vă îmbunătăți documentația utilizatorului și vom analiza câteva exemple de conținut excelent de asistență pentru utilizatori.

Începeți cu un plan

Ca majoritatea lucrurilor din viață, cel mai bine este să începeți cu un plan, iar crearea documentației pentru utilizator nu este diferită. De aceea, veți dori să vă asigurați că vă puneți (și eventual celor care solicită documentația) o mulțime de întrebări înainte de a începe.

1. Luați în considerare publicul dvs

Pentru cine faci asta? Utilizatorul final? Un administrator de sistem? Acest conținut va fi revizuit doar intern sau va fi văzut și extern? Pentru cine creați documentația utilizatorului vă ajută să încadrați informațiile pe care le partajați.

2. Evaluează și ține cont de obiectivul tău final

Scopul principal al oricărei documentații este de a-ți învăța ceva publicul. După ce ați determinat cine vă va consuma documentația, veți dori să decideți ce doriți să obțină din ea.

Care este acțiunea pe care ați dori ca publicul dvs. să poată efectua după ce ați examinat documentația? Ținând cont de răspunsul la această întrebare, veți putea oferi cantitatea potrivită de conținut pentru sarcina în cauză.

3. Asigurați-vă că documentația dvs. de utilizator este ușor de găsit

Documentația ascunsă a utilizatorului este aproape la fel de inutilă ca documentația proastă a utilizatorului. Este important să vă asigurați că documentația de utilizator pe care o creați este ușor de găsit pentru cei care au nevoie de ea.

Acest lucru nu înseamnă doar să vă asigurați că este vizibil, ci înseamnă și că utilizatorii pot naviga în documentația dumneavoastră tehnică și pot găsi rapid răspunsuri la întrebările lor.

Cu cât publicul tău poate găsi mai repede aceste răspunsuri, cu atât vor fi mai fericiți. De asemenea, vă va economisi timp de a trebui să răspundeți la întrebări importante, dar frecvente, despre produsul dvs.

Scriere concisă, puternică

Scrierea puternică este esențială pentru o documentare excelentă pentru utilizator. Dar scrierea afectează mai mult decât modul în care se citește sau sună documentația utilizatorului. Poate influența cât de ușor este să navighezi în documentația utilizatorului.

4. Scrieți titluri și subtitrări descriptive

Asigurați-vă că titlurile dvs. sunt utile și, cel mai important, specifice. Scrierea de titluri sau subtitrări care sunt formulate pentru a răspunde la o întrebare este adesea cea mai bună. Încadrarea titlurilor în acest fel face mai ușor pentru utilizatorii dvs. finali să găsească ceea ce caută și, de asemenea, vă ajută să scrieți articole care se adresează în mod direct nevoilor utilizatorilor.

Unbounce face o treabă fantastică de a scrie titluri și subtitrări eficiente în documentația utilizatorului. Acest lucru face ca documentația lor să fie ușor de navigat. Fiecare articol specific are propriul său cuprins, ceea ce face ca găsirea răspunsului la o anumită întrebare să fie o ușoară.

5. Ușurează navigarea

Furnizarea de informații într-un mod ușor de scanat ajută utilizatorii să economisească timp. Ca oameni, apreciem orice economie de timp pe care o putem obține. În plus, este posibil ca utilizatorii să nu știe exact ce caută. Atunci conținutul ușor de răsfoit este cel mai benefic.

IBM face o treabă bună făcând conținutul lor de ajutor ușor de răsfoit, organizând un cuprins curat și oferind subiecte conexe.

6. Faceți-l ușor de căutat

Google ne-a instruit că găsirea răspunsurilor la întrebările noastre este la fel de simplă ca și introducerea lor într-o casetă de căutare. Documentația dvs. de ajutor ar trebui să reflecte această așteptare. Dacă conținutul tău de ajutor nu poate fi căutat, atunci probabil că nu este foarte util.

Baza de cunoștințe aprofundată a Hubspot face autoservirea ușoară pentru clienții lor.

Utilizați elementele vizuale pentru a îmbunătăți înțelegerea

O documentație bună pentru utilizator este foarte vizuală. În timp ce scrierea și textul puternic sunt esențiale pentru o documentare extraordinară pentru utilizatori, oamenii învață cel mai bine atunci când sunt prezente și imaginile.

7. Utilizați capturi de ecran adnotate

Capturile de ecran adnotate sunt imagini puternice de utilizat în documentația utilizatorului. Îndepărtează presupunerile pentru utilizatori, arătând exact ce pași trebuie să facă.

Cu programe precum TechSmith Snagit, este ușor să adăugați înștiințări text, săgeți și multe altele la capturile de ecran. De exemplu, veți observa că folosesc capturi de ecran adnotate pe care le-am făcut cu Snagit pe parcursul acestei postări pe blog.

Dacă vă simțiți inspirat, puteți chiar să încercați Instrumentul de pași Snagit, care vă permite să identificați părți ale unei imagini plasând înștiințări comandate în timp ce indicați și faceți clic. De fiecare dată când faceți clic pentru a adăuga un alt pas, numărul avansează automat.

O companie care face o treabă minunată utilizând puterea capturilor de ecran în documentația lor este Asana. În documentația lor minunată pentru utilizatori, aceștia folosesc capturi de ecran adnotate pentru a ghida în mod clar clienții.

8. Folosiți videoclipul pentru a arăta, nu a spune

Videoclipul funcționează bine pentru a demonstra un proces. O mulțime de documentație minunată pentru utilizator combină puterea video cu instrucțiuni text. De exemplu, este o practică bună să folosiți un scurt videoclip pentru a parcurge rapid un proces.

Apoi, alături de videoclip, puteți oferi un ghid text pas cu pas pe care utilizatorii să-l consulte în timp ce încearcă ei înșiși procesul. În acest fel, ei nu trebuie să vizioneze videoclipul din nou și din nou dacă au nevoie doar de un memento rapid.

În tutorialele noastre despre produse TechSmith, folosim un videoclip principal pentru a oferi o imagine de ansamblu completă a funcției sau a subiectului pe care îl discutăm. Apoi, sub videoclip, oferim fragmente însoțite de capturi de ecran sau GIF-uri animate pentru a reitera punctele principale ale videoclipului.

9. Afișați exemple și rezultate finale

Utilizatorii trebuie să știe cum arată finalizarea cu succes a fiecărei sarcini. Oferirea utilizatorilor cu o captură de ecran a unui exemplu de rezultat final este o modalitate bună de a demonstra publicului dvs. rezultatul ideal.

Documentația excelentă pentru utilizatori facilitează utilizatorilor finali să găsească răspunsuri la întrebările lor, ceea ce creează utilizatori fericiți și mulțumiți.

O parte cheie a creării unei documentații extraordinare pentru utilizatori este furnizarea de informații clare, ușor de scanat. Elementele vizuale precum capturile de ecran, videoclipurile sau GIF-urile animate sunt toate modalități excelente de a comunica mai eficient și mai eficient cu utilizatorii dvs.