Cum să construiți cea mai bună documentație pentru utilizator

Sunt șanse ca dacă produsele dvs. sunt mai complexe decât o rolă de prosoape de hârtie, creați un fel de documentație pentru utilizator pentru a ajuta oamenii să învețe cum să le folosească.

Un manual de produs sau un ghid al utilizatorului bine conceput, ușor de utilizat, poate face diferența între o experiență fantastică pentru clienți și una teribilă.

În plus, documentația pentru utilizatori nu este doar pentru utilizatorii noi.

Clienții cu experiență pot consulta, de asemenea, manualele de utilizare sau ghidurile de produse pentru a-și reîmprospăta amintirile cu privire la o funcție pe care nu au folosit-o des sau pentru a rezolva o anumită problemă pe care o au.

Pentru această postare, ne vom concentra mai ales pe cele mai bune practici pentru crearea documentației pentru utilizatori pentru produse non-fizice, cum ar fi software-ul, dar majoritatea (dacă nu toate) aceste sfaturi se aplică și domeniului hardware.

Iată ce vei învăța:

• Ce este documentația utilizatorului și de ce este importantă.
• Cum documentația utilizatorului final face parte din experiența clientului.
• Cât de bună documentație pentru utilizatori poate ajuta să scadă de sarcina echipei de asistență pentru clienți.
• De ce conținutul vizual este ingredientul secret al celei mai bune documentații.
• Elementele esențiale care asigură cea mai bună documentație pentru utilizator.
• Cei patru pași pentru crearea unei documentații care să-ți încânte clienții și să reziste testului timpului.

Ce este documentația utilizatorului?

Documentația utilizatorului (numită și manuale pentru utilizatorul final, ghiduri pentru utilizatorul final, manuale de instrucțiuni etc.) este conținutul pe care îl oferiți utilizatorilor finali pentru a-i ajuta să aibă mai mult succes cu produsul sau serviciul dvs.

Acestea sunt materialele de instruire care sunt însoțite de produsul dvs. pentru a ajuta pe cineva să învețe să-l folosească corect sau, în cazul produselor fizice, chiar să îl asamblate.

Dacă ați asamblat vreodată o piesă de mobilier IKEA, ați folosit documentația pentru utilizatorul final.

Cu toate acestea, documentația utilizatorului ia mai multe forme.

Jocurile video vin cu manuale care vă spun ce butoane să apăsați pentru a-i împușca pe cei răi. Documentația software vă arată ce poate face achiziția dvs. și cum să o faceți.

Formularele fiscale vin cu ghiduri despre cum să le completezi corect.

Mașinile de tuns iarba și mașinile de zăpadă au ghiduri de produse pentru a vă arăta cum să porniți motoarele și unde să umpleți combustibilul.

Treceți în jos la cum să faceți documentația utilizatorului

De ce este importantă documentația utilizatorului?

Știi că produsul tău este grozav. Vrei să știe și clienții tăi. Documentația pentru utilizatori vă ajută să vă asigurați că clienții sau utilizatorii învață cu adevărat cum să profite la maximum de produsul dvs.

Fie că este vorba despre cum să salvați un document, să porniți un motor, să folosiți un instrument specific sau chiar despre informații importante despre siguranță, documentația pentru utilizatorul final este o parte importantă a relației dvs. cu clienții.

Documentația utilizatorului vă poate încânta clienții

Documentarea utilizatorului este ușoară, nu? Adică, scrie doar câteva lucruri despre cum să-ți folosești produsul și ești gata!

Nu este chiar atât de simplu.

Este mai mult decât un simplu material „cum se face”. Face parte din experiența clientului. Și asta înseamnă că este și material de marketing.

În calitate de consumator, am experimentat atât ghiduri de utilizare grozave, cât și oribile. Pun pariu că majoritatea dintre voi ați avut experiențe similare.

Un manual de utilizare grozav sau un ghid de produs le arată clienților dumneavoastră că vă pasă nu doar dacă vă cumpără produsul, ci și dacă au o experiență cu adevărat grozavă în utilizarea acestuia.

Clienții care simt că îți pasă de ei dincolo de portofelul lor vor reveni în continuare la tine.

Dacă doriți ca ei să strige lumii despre cât de mult vă plac produsele și serviciile, furnizarea de documentație extraordinară pentru utilizatori este o parte esențială a acelei experiențe post-cumpărare.

Cum documentația utilizatorului vă sprijină echipa de asistență

Oamenii vă contactează adesea echipa de asistență atunci când ceva nu funcționează, dar pot suna și atunci când pur și simplu nu își pot da seama de ceva. A avea o documentație excelentă pentru utilizatori vă ajută echipa de asistență în două moduri majore.

1. Le oferă un ghid ușor de referință

Documentația excelentă pentru utilizatori nu trebuie să fie doar pentru clienți. Echipa dvs. de asistență pentru produse poate folosi documentația pentru a vă sprijini mai bine clienții atunci când vă solicită ajutor. Când includeți piese esențiale, cum ar fi un cuprins sau un index, aceștia pot găsi rapid informațiile de care au nevoie. Și, dacă este un document electronic căutat, este și mai bine! Vom afla mai multe despre acest lucru mai târziu în articol.

2. Reduce apelurile

După cum sa menționat mai sus, oamenii apelează adesea la asistență atunci când nu își pot da seama de ceva. Dar, dacă clienții își pot da seama singuri, este mult mai puțin probabil să aibă nevoie de ajutor. De fapt, mai mult de 70% dintre oameni preferă să folosească site-ul web al unei companii pentru ajutor, decât să primească asistență folosind telefonul sau e-mailul.

Chiar și cea mai bună documentație nu va elimina toate aceste apeluri, dar crearea de ghiduri de utilizare și manuale care sunt clare, cuprinzătoare și concise va contribui în mare măsură la reducerea volumului total de solicitări de asistență.

Care sunt elementele esențiale ale documentației excelente pentru utilizatori?

Chiar dacă fiecare produs este unic și va necesita elemente diferite pentru a crea documente pentru utilizatori cu adevărat grozave, există câteva cele mai bune practici pentru documentația utilizatorului final de urmat indiferent de situație.

Documentația excelentă pentru utilizator ar trebui să includă:

• Limbaj simplu
• Simplitate
• Imagini vizuale
• O concentrare pe problemă
• O ierarhie și un flux logic
• Un cuprins
• Conținut căutabil
• Conținut accesibil
• Design bun
• Feedback de la utilizatori reali
• Link-uri către resurse suplimentare

Limbaj simplu

Nimic nu va frustra un client mai mult decât să citească ceva ce nu poate înțelege. Nimeni nu vrea să se simtă prost, iar limbajul care îl face pe client să se simtă așa, cu siguranță nu este o modalitate de a promova o experiență grozavă.

Folosiți un limbaj simplu și simplu ori de câte ori este posibil pentru a vă ajuta clienții să înțeleagă chiar și cele mai complexe concepte.

Amintiți-vă, scrieți pentru utilizator, nu pentru dezvoltator.

Sună ca o idee deloc, dar a scrie într-un limbaj simplu despre un produs sau serviciu pe care îl cunoști, din față în spate, este mai dificil decât ai putea crede. Cunoașteți tot felul de jargon, acronime și alte informații „din interior” pe care clienții probabil nu le cunosc. Este firesc să-l folosești.

Dar acolo poți avea probleme serioase.

Nu presupuneți că clientul dvs. știe ceva despre produsul dvs. Nu presupuneți că cunosc toate cuvintele la modă tehnice și/sau industriale pe care probabil le folosiți în fiecare zi în biroul dvs.

Nu scrie ca și cum ar fi copii, dar înțelege că ar putea avea nevoie de ajutor suplimentar pentru a-i pune cu adevărat la curent. Scrieți documentația într-un mod ușor de citit.

Simplitate

Păstrați documentația cât mai simplă posibil pentru a-și atinge scopul. Acest lucru se aplică atât conținutului documentului, cât și designului acestuia. Blocurile lungi de text și paginile strâns cu conținut scris și grafic pot face ca ghidurile de utilizare sau manualele să se simtă intimidante și neprietenoase.

Clienții care sunt intimidați de materialele dvs. de utilizator sunt mult mai probabil să apeleze echipa de asistență pentru ajutor decât să încerce să își rezolve singuri întrebările. În plus, este mult mai puțin probabil să aibă o experiență bună pentru clienți.

Imagini vizuale

Cea mai bună documentație pentru utilizator ilustrează perfect expresia „arată, nu spune”.

Conținutul vizual, inclusiv imagini, capturi de ecran adnotate, grafice și videoclipuri, arată rapid cuiva cum funcționează produsul dvs. Nu trebuie să citească despre asta: o pot vedea!

Cercetări recente de la TechSmith arată că oamenii absorb de fapt informațiile vizuale mai repede și îndeplinesc sarcinile mai bine atunci când instrucțiunile sunt furnizate cu conținut vizual sau video.

Conținutul vizual ajută, de asemenea, la spargerea blocurilor lungi de text și poate ajuta la eliminarea multor text, ceea ce face ca multe ghiduri de utilizare sau manuale să se simtă intimidante și neplăcute.

Modalitățile populare de includere a conținutului vizual în documentația utilizatorului includ capturi de ecran, înregistrări de ecran, videoclipuri tutorial și multe altele.

Ați auzit de grafică simplificată? Denumite uneori interfață de utilizator simplificată (sau SUI), grafica simplificată preia imagini ale unei interfețe de utilizator sau alte elemente grafice și, așa cum sugerează și numele, le simplifică. Această versiune de bază evidențiază cele mai esențiale informații, reducând în același timp textul și graficele care nu sunt importante pentru formele mai simple.

Deci, ceva care arată așa:

Acum arată așa:

Dacă încercam să arăt cuiva cum să selecteze elementul de meniu Conectare dispozitiv mobil, a doua imagine elimină toată dezordinea și permite ochilor clientului să se concentreze acolo unde trebuie.

Sunt șanse să fi întâlnit deja grafică simplificată și nici măcar nu ți-ai dat seama, ca aceasta de la Centrul de învățare G Suite:

Există o mulțime de instrumente, dar dacă sunteți în căutarea unor modalități puternice și simple de a crea capturi de ecran și înregistrări de ecran, vă recomand să descărcați o versiune de încercare gratuită a Snagit.

Concentrați-vă pe problema de rezolvat

Fiecare produs rezolvă o problemă. Dar, de prea multe ori, suntem atât de îndrăgostiți de caracteristicile noastre grozave ale produsului, încât tot ceea ce vrem să facem este să evidențiem ceea ce poate face, mai degrabă decât motivul pentru care clienții noștri au nevoie de el.

Asigurați-vă că le arătați utilizatorilor cum să efectueze sarcini cu produsul dvs.

Desigur, acest lucru va implica caracteristicile produsului, dar le va evidenția în contextul de a ajuta utilizatorul să ajungă la motivul pentru care a cumpărat produsul dvs. în primul rând - pentru a rezolva o problemă specifică.

De exemplu, tutorialele noastre Camtasia și Snagit (da, videoclipurile tutoriale pot fi o formă de documentare) evidențiază caracteristici specifice, dar fac acest lucru în contextul motivului pentru care cineva ar putea folosi acea caracteristică anume. Este vorba despre de ce, nu doar despre cum.

Iată un exemplu grozav...

Ierarhie și flux logică

O documentație bună necesită o ierarhie de titluri și subtitluri care să permită utilizatorului să știe ce le va arăta fiecare secțiune. Și acea ierarhie ar trebui să urmeze un flux logic care ajută utilizatorul să învețe să folosească produsul în cel mai util mod.

De exemplu, probabil că nu doriți să începeți documentația arătându-le clienților cum să folosească funcțiile mai avansate fără să le arătați mai întâi elementele de bază ale modului în care funcționează produsul dvs. Începeți mai întâi cu lucrurile simple și apoi, pe măsură ce utilizatorii dvs. își dezvoltă cunoștințele, arătați-le funcțiile avansate.

Cuprins

Un cuprins oferă clienților dumneavoastră o modalitate simplă, eficientă și familiară de a găsi rapid o soluție la întrebarea sau problema lor. Este chiar la începutul documentului, așa că nu trebuie să parcurgă paginile de text pentru a găsi ceea ce caută. Ar trebui să includă toate rubricile și subtitlurile principale, așa cum este descris mai sus.

Faceți-l căutabil

A existat o perioadă în care majoritatea documentației utilizatorului era tipărită. Acum, într-o eră în care aproape toată lumea are acces la un smartphone, este mai logic să creăm documentație electronică. Asta nu înseamnă că nu poți crea și versiuni tipărite, dar o versiune electronică oferă o serie de avantaje pe care le vom discuta mai detaliat mai jos.

Asemenea unui cuprins, conținutul care poate fi căutat oferă utilizatorilor acces mai ușor la conținutul dvs. și îi ajută să găsească singuri soluții.

Accesibilitate

Creați conținut accesibil. Aceasta înseamnă asigurarea faptului că documentația electronică respectă standardele de accesibilitate pentru persoanele care pot fi nevăzători sau cu deficiențe de vedere, surde sau cu probleme de auz sau care pot avea dizabilități cognitive.

Nu uitați, mulți dintre clienții dvs. au nevoie de acest lucru pentru a înțelege și a accesa complet documentația dvs. de utilizator. Nu-i lăsa în urmă!

Design bun

Oferiți utilizatorilor dvs. un document pe care doresc să-l examineze și vor avea mai multe șanse să-l folosească.

Proiectați materialele având în vedere clienții dvs. Fă-l utilizabil și prietenos. Evitați paragrafele lungi de text sau paginile care sunt prea pline de conținut. Permiteți spațiu alb pentru a ajuta la eliminarea monotoniei și pentru a face perspectiva de a învăța un produs nou mai puțin descurajantă.

Includeți grafice și imagini cât mai mult posibil pentru a le afișa, în loc să le spuneți clienților cum să vă folosească produsul. Pentru documentația electronică, utilizați videoclipuri și GIF-uri.

Utilizați fonturi consistente și culori complementare în mai multe documente. Dacă organizația dvs. are un ghid de stil (pe care vă recomand FOARTE să îl creați dacă nu există deja unul), asigurați-vă că documentația dvs. aderă la acesta.

Șabloanele Snagit fac incredibil de ușor să creați documentație pentru utilizator cu aspect profesional dintr-o serie de capturi de ecran sau alte imagini. Pur și simplu strângeți imaginile de care aveți nevoie, alegeți Creare și apoi Imagine din șablon și sunteți pe drum.

Snagit vine cu o mulțime de șabloane gratuite, concepute profesional, iar cu TechSmith Assets pentru Snagit, aveți acces la o mulțime de mai multe!

Feedback de la utilizatori reali și/sau testeri beta

Nu puteți crea o documentație cu adevărat excelentă pentru utilizatori până când nu ascultați oamenii din afara organizației dvs. care folosesc efectiv produsele.

Aflați punctele lor dureroase și încercați să le abordați cât mai bine puteți. Aflați ce vă spun că este necesar să știți pentru a vă folosi cel mai bine produsele. Deși unele dintre ele ar putea părea evidente, vă garantez că veți învăța lucruri pe care nici măcar nu le-ați gândit.

Link-uri către alte documentații

Asigurați-vă că clienții dvs. au acces la mai multe resurse ale organizației dvs. despre cum să aveți succes cu produsele dvs. Pentru documentația electronică pentru utilizatori, acest lucru poate fi la fel de simplu ca furnizarea de link-uri către tutoriale, întrebări frecvente, forumuri pentru utilizatori și multe altele.

Dar chiar și documentația tipărită poate include lucruri precum adresele site-urilor web și numerele de telefon pentru asistență suplimentară.

Primă! Adăugați instrucțiuni pas cu pas

Ghidurile pas cu pas ajută la evitarea blocurilor lungi de text și oferă o modalitate mult mai clară de a arăta un proces decât încercarea de a-l explica numai prin text. Sunt mai ușor de urmărit, mai ușor de înțeles și oferă o experiență mult mai ușor de utilizat decât să spui cuiva cum să finalizeze o sarcină.

Și nu uitați, includerea conținutului vizual în instrucțiunile dvs. pas cu pas le face și mai bune.

Snagit oferă un instrument de pas ușor de utilizat, care vă ajută să creați documentație pas cu pas grozavă. În plus, Instrumentul Combinați imagini vă permite să combinați capturi de ecran individuale și alte imagini într-o singură imagine pentru o editare și o marcare mai ușoară.

Cum să creați o documentație excelentă pentru utilizator

Pasul 1: Planifică

Fiecare set grozav de documente de utilizator începe cu un plan. Iată câteva sfaturi despre cum să ajungi unde vrei să ajungi.

Știți de unde să începeți

Mulți oameni presupun că, dacă vă cunoașteți produsul, puteți începe să vă creați documentația. Dar există mult mai multe lucruri în ea. În schimb, începeți cu un plan pentru a vă asigura că vă ajutați efectiv utilizatorii.

Înainte de a face documentare, iată câteva lucruri de luat în considerare:

• Ce ar trebui să includeți? Ce ar trebui să lași afară? (Sugestie: aici feedback-ul utilizatorilor poate fi CU adevărat util!)
• În ce ordine ar trebui să prezentăm informațiile? (Îți amintești schițele eseurilor de la școală? Folosește-le!)
• Ce alte resurse vor fi disponibile? Cum vom oferi acces/linkuri către acestea?
• Cine este responsabil pentru crearea documentului? Cine este responsabil pentru feedback-ul asupra documentului? Cine are aprobarea finală?
• Va trebui să fie tradus sau localizat?

Răspunsurile la aceste întrebări modelează modul în care vă creați documentația. Planificarea asigură un proces fără probleme și un document de utilizator mai bun.

Cunoaște-ți produsul

Asigurați-vă că vă cunoașteți produsul.

Asta nu înseamnă că trebuie să fii un expert absolut în orice, dar oricine creează un manual de utilizare sau un ghid de utilizare ar trebui să aibă experiență practică cu produsul.

Bazează-te pe experții tăi în materie pentru cunoștințe mai aprofundate, dar ar trebui să știi cum să le folosești singur înainte de a încerca să înveți pe altcineva.

Alegeți formatul dvs

În plus, formatul final al unui document este la fel de important. Va fi doar tipărit? Va fi electronic? Dacă da, unde va locui?

Nu a trecut cu mult timp în urmă că aproape toată documentația utilizatorului a fost doar tipărită. Cu toate acestea, cu excepția cazului în care aveți un motiv foarte întemeiat, vă recomand cel puțin să aveți o versiune electronică disponibilă pe site-ul dvs.

Majoritatea utilizatorilor au acces 24 de ore din 24 la smartphone-uri, computere sau tablete și sunt obișnuiți să găsească orice doresc să afle oricând doresc. Punerea online a resurselor utilizatorilor le oferă acces oriunde s-ar afla, ceea ce înseamnă că nu trebuie să caute prin sertare sau dulapuri pentru a găsi un manual de utilizare pe care nu l-au văzut de ani de zile.

De asemenea, este pur și simplu mai ușor să faci documentația electronică accesibilă persoanelor cu dizabilități. O versiune numai tipărită va funcționa pentru majoritatea oamenilor, dar sunteți pregătit să creați o versiune braille pentru utilizatorii care pot fi orbi sau cu deficiențe de vedere? Dar utilizatorii care au o dizabilitate fizică în care le este greu să manipuleze obiecte cu mâinile?

Există instrumente pentru a face documentația electronică mai ușor de accesat pentru toți, dar versiunile numai tipărite oferă o problemă de accesibilitate mult mai dificilă.

În plus, documentația electronică este mult mai ușor de actualizat, deoarece se află pe web.

Ar trebui să fac documentația mea un PDF?

Dacă doriți să oferiți o versiune PDF descărcabilă a documentației dvs., este în regulă. Dar asigurați-vă că este disponibil și pe site-ul dvs. într-un format non-PDF.

Pasul 2: Creați documentul dvs. de utilizator

După ce ați răspuns la toate întrebările și ați luat toate deciziile prezentate mai sus, este timpul să vă creați documentația pentru utilizator. Nu am de gând să vă spun cum EXACT să creați documentația pentru produsul dvs. specific, dar există câteva lucruri cheie de care trebuie să aveți în vedere.

• Evitați jargonul și termenii foarte tehnici, cu excepția cazului în care este absolut necesar (și apoi asigurați-vă că le definiți).
• Evitați acronimele decât dacă explicați ce înseamnă ele.
• Folosiți un stil de scriere comun recunoscut, cum ar fi AP sau Chicago, ori de câte ori este posibil. Dacă organizația ta are un ghid de stil al companiei, folosește-l.
• Nu presupuneți că utilizatorul știe nimic despre produsul dvs. sau despre ce face acesta. ARĂTAȚI-le ce trebuie să știe pentru a avea succes.
• Nu uitați să folosiți un limbaj simplu. Scrieți pentru un nivel de clasa a opta sau mai jos. Chiar și pentru cititorii avansați, limbajul simplu duce la o procesare mai rapidă și o mai bună înțelegere.
• Designul ar trebui să fie plăcut, să nu fie intimidant și să atragă utilizatorul. Fă-i să dorească să folosească documentația ta.

Pasul 3: Testează-l

Un ghid de utilizare este grozav numai dacă îi ajută pe clienți să vă folosească produsul la maximum. Și nu poți ști asta până când cineva îl folosește. Înainte ca noua ta creație să iasă în lume, vrei să o testezi. Iată câteva sfaturi!

• Cea mai bună practică: dă-l unui grup de utilizatori reali sau testeri beta și vezi cum se descurcă. Încorporați feedback-ul lor în documentul final.
• Dacă nu aveți feedback de la utilizatorii de testare beta, testați-l intern, de preferință cu angajații care sunt cel mai puțin familiarizați cu produsul.
• Obțineți feedback de la dezvoltatori și ingineri. Ei cunosc produsul mai bine decât oricine și pot sublinia lucruri pe care este posibil să le fi ratat.

Pasul 4: păstrați documentația la zi

Când produsul dvs. se schimbă, va trebui să păstrați documentația pentru utilizator actualizată. După cum sa menționat mai sus, acest lucru oferă documentației electronice un avantaj imens față de tipărire. Cu toate acestea, chiar și documentele tipărite pot fi actualizate și puse la dispoziție pentru descărcare pe site-ul dvs. web.

Amintiți-vă, conținutul dvs. este excelent numai dacă este corect. Asigurați-vă că ceea ce le oferiți clienților îi ajută cu adevărat să vă folosească produsul.

rezumat

Dacă nu vă amintiți nimic altceva, rețineți că documentația excelentă pentru utilizatori ar trebui creată, proiectată și prezentată într-un mod care să fie cel mai util pentru utilizatorii dvs. .

Oferiți-le documentație care continuă să-i încânte și care oferă tipul de experiență client pe care ați dori să o aveți.

Faceți-vă documentația accesibilă, utilă și vizuală.

Puneți frecvent întrebări