Documentație de produs
Ajutați utilizatorii să finalizeze sarcinile pe care aplicația dvs. le acceptă
Oferiți utilizatorilor ghiduri practice care să explice fluxurile aplicației și să îi ajute să își finalizeze sarcinile.
Transformă funcționalitatea produsului în instrucțiuni practice
- Pregătiți luneta de ghidare
Analizați secțiunile documentației și publicul țintă pentru fiecare.
- Răspunde la întrebările despre conținut
Clarificați fluxurile de lucru și informațiile pe care un ghid ar trebui să le explice.
- Urmați instrucțiunile.
Verificați stadiul lucrărilor și adresa site-ului de documentație.
Explicați cum se utilizează aplicația
Documentația completează o prezentare a produsului cu instrucțiuni practice. Începeți cu un ghid de inițiere, apoi ajutați utilizatorii să parcurgă fluxurile de lucru pe care aplicația le oferă efectiv.
Configurarea documentației afișează definițiile secțiunilor și întrebările. Oferiți un context care să ajute la explicarea unei sarcini în limba utilizatorului.
Menține ghidul conectat la aplicația în funcțiune
Sprijină prima acțiune utilă. Un ghid de inițiere oferă utilizatorilor noi o modalitate rapidă de a accesa produsul. Acesta ar trebui să explice de unde să înceapă, ce informații sunt necesare și ce rezultat confirmă că sarcina a fost finalizată.
Explică un flux de lucru recurent. Un ghid detaliat prezintă etichetele și acțiunile reale ale aplicației. Cerințele preliminare, pașii numerotați și rezultatul așteptat ajută pe cineva să repete o sarcină de afaceri fără a interpreta o descriere generală a ecranului.
Răspunde la o întrebare generală. Unele întrebări se referă la conturi, costuri sau publicare, nu doar la un singur ecran. O secțiune de întrebări frecvente oferă un răspuns concis și linkuri către ghidul relevant, menținând procedura într-un singur loc în loc să o repete pe tot site-ul.
Păstrați ghidurile conectate la produs
Revizuiți documentația după o modificare semnificativă a aplicației. Un ghid ar trebui să utilizeze etichetele și comportamentul pe care utilizatorii îl pot vedea efectiv.
Documentația rulează pe propriul său serviciu public. Adăugați un link către aceasta de pe site-ul web și verificați ghidurile în limbile în care publică proiectul dvs.
Ajutați un utilizator să finalizeze următoarea sarcină
Un ghid practic explică de unde să începeți, ce informații sunt necesare și cum să verificați rezultatul. Valoarea lui constă în a-l ajuta pe cititor să acționeze în aplicație.
Folosiți ghidurile conexe pentru a continua parcursul atunci când sarcina traversează mai multe domenii. Examinați documentația când un ecran se schimbă, astfel încât instrucțiunile să rămână utile după o evoluție.
De la funcționalitatea stabilită la un ajutor util
Pregătiți luneta de ghidare. Revizuiți secțiunile din documentație și sarcinile pe care ar trebui să le explice. Mențineți clar utilizatorul vizat și comportamentul aplicației.
Furnizați contextul lipsă. Răspunde la întrebări despre cerințe, reguli și rezultate. Textul trebuie să folosească interfața reală, nu controale inventate.
Revizuiește după publicare și modifică.. Urmați un ghid în aplicație, verificați limbile și linkurile aferente, apoi revedeți-l când sarcina de bază se modifică.
Faceți produsul mai ușor de utilizat după prima vizită
Furnizați instrucțiuni care să conducă la un rezultat, alături de prezentarea publică a ceea ce face aplicația.
Întrebări despre documentația produsului
O pagină cu funcționalități ajută un potențial client să înțeleagă capacitatea și valoarea acesteia. Un ghid ajută un utilizator să efectueze o sarcină, cu comenzile, cerințele preliminare și rezultatul efectiv. Ele se completează reciproc.
Instrumentele de documentare prezintă definițiile secțiunilor și întrebările. Analizați sarcinile pe care le acceptă aplicația, furnizați contextul lipsă și urmăriți progresul scrierii.
Proiectul publică ghidurile localizate disponibile pentru domeniul său. Verificați fiecare limbă publicată pentru a vă asigura că reține procedura completă și etichetele corecte ale interfeței.
După o modificare care afectează sarcina, controalele acesteia sau rezultatul așteptat, verificați textul în raport cu aplicația funcțională, în loc să presupuneți că instrucțiunile inițiale rămân valabile.
O referință de endpoint aparține unui proiect cu o API activă și funcțională. Utilizați operațiunile live și referința reală; rutele planificate nu sunt suficiente pentru a documenta o integrare utilizabilă.