Produktová dokumentácia
Pomôžte používateľom dokončiť úlohy, ktoré vaša aplikácia podporuje
Poskytnite používateľom praktické príručky, ktoré vysvetľujú cesty v aplikácii a pomáhajú im splniť ich úlohy.
Premeňte funkcionalitu produktu na praktické pokyny
- Pripravte rozsah príručky
Skontrolujte sekcie dokumentácie a ich zamýšľané publikum.
- Odpovedzte na otázky o obsahu
Spresnite pracovné postupy a informácie, ktoré má príručka vysvetliť.
- Sledujte verejnú službu
Skontrolujte priebeh tvorby a adresu webu dokumentácie.
Vysvetlite, ako používať aplikáciu
Dokumentácia dopĺňa prezentáciu produktu o praktické pokyny. Začnite úvodom do práce a potom používateľov preveďte pracovnými postupmi, ktoré aplikácia skutočne podporuje.
Konfigurácia dokumentácie zobrazuje definície sekcií a otázky. Poskytnite kontext, ktorý pomôže vysvetliť úlohu jazykom používateľa.
Udržujte príručku prepojenú s funkčnou aplikáciou
Podporte prvý užitočný krok. Úvodná príručka dáva novým používateľom krátku cestu do produktu. Má vysvetliť, kde začať, aké informácie sú potrebné a aký výsledok potvrdzuje, že je úloha dokončená.
Vysvetlite opakujúci sa pracovný postup. Podrobná príručka sa riadi skutočnými označeniami a akciami aplikácie. Predpoklady, očíslované kroky a očakávaný výsledok pomáhajú zopakovať obchodnú úlohu bez interpretácie všeobecného opisu obrazovky.
Odpovedzte na prierezovú otázku. Niektoré otázky sa týkajú účtov, nákladov alebo zverejnenia, a nie jednej obrazovky. Časté otázky poskytujú stručnú odpoveď a odkazujú na príslušnú príručku, takže postup zostáva na jednom mieste a neopakuje sa na celom webe.
Udržujte príručky prepojené s produktom
Po významnej zmene aplikácie skontrolujte dokumentáciu. Príručka má používať označenia a správanie, ktoré používatelia skutočne vidia.
Dokumentácia beží vo vlastnej verejnej službe. Prepojte ju z webu a skontrolujte príručky v jazykoch, ktoré váš projekt zverejňuje.
Pomôžte používateľovi dokončiť ďalšiu úlohu
Praktická príručka vysvetľuje, kde začať, aké informácie sú potrebné a ako overiť výsledok. Jej hodnota spočíva v tom, že čitateľovi pomáha konať v aplikácii.
Keď úloha zasahuje do viacerých oblastí, pokračujte v ceste pomocou súvisiacich príručiek. Pri zmene obrazovky skontrolujte dokumentáciu, aby pokyny zostali užitočné aj po zmene.
Od dohodnutej funkcionality po užitočnú pomoc
Pripravte rozsah príručky. Skontrolujte sekcie dokumentácie a úlohy, ktoré majú vysvetliť. Zamýšľaný používateľ a správanie aplikácie musia zostať jasné.
Doplňte chýbajúci kontext. Odpovedzte na otázky o predpokladoch, pravidlách a výsledkoch. Text má vychádzať zo skutočného rozhrania, nie z vymyslených ovládacích prvkov.
Kontrola po zverejnení a zmene. Prejdite príručku v aplikácii, skontrolujte jej jazyky a súvisiace odkazy a vráťte sa k nej, keď sa zmení úloha, ktorú opisuje.
Uľahčite používanie produktu po prvej návšteve
Poskytnite pokyny, ktoré vedú k výsledku, popri verejnej prezentácii toho, čo aplikácia robí.
Otázky o dokumentácii produktu
Stránka funkcie pomáha potenciálnemu zákazníkovi pochopiť možnosť a jej hodnotu. Príručka pomáha používateľovi vykonať úlohu so skutočnými ovládacími prvkami, predpokladmi a výsledkom. Navzájom sa dopĺňajú.
Nástroje dokumentácie zobrazujú definície sekcií a otázky. Skontrolujte úlohy, ktoré aplikácia podporuje, doplňte chýbajúci kontext a sledujte priebeh písania.
Projekt zverejňuje lokalizované príručky dostupné pre jeho rozsah. Skontrolujte každý zverejnený jazyk, aby zachoval úplný postup a správne označenia rozhrania.
Po zmene, ktorá ovplyvní úlohu, jej ovládacie prvky alebo očakávaný výsledok. Porovnajte text s funkčnou aplikáciou a nepredpokladajte, že pôvodné pokyny stále platia.
Referencia koncových bodov patrí k projektu s aktívnym, funkčným API. Použite jeho živé operácie a skutočnú referenciu; plánované cesty nestačia na zdokumentovanie použiteľnej integrácie.