Produktová dokumentace
Pomozte uživatelům dokončit úkoly, které vaše aplikace podporuje
Poskytněte uživatelům praktické návody, které vysvětlují postupy v aplikaci a pomáhají jim dokončit jejich úkoly.
Převeďte funkce produktu na praktické pokyny
- Připravte rozsah návodu
Zkontrolujte sekce dokumentace a jejich cílové publikum.
- Odpovězte na otázky k obsahu
Ujasněte pracovní postupy a informace, které má návod vysvětlit.
- Sledujte veřejnou službu
Prohlédněte si průběh tvorby a adresu webu s dokumentací.
Vysvětlete, jak aplikaci používat
Dokumentace doplňuje prezentaci produktu o praktické pokyny. Začněte úvodním návodem a poté uživatele provádějte pracovními postupy, které aplikace skutečně podporuje.
Konfigurace dokumentace zobrazuje definice sekcí a otázky. Doplňte kontext, který pomůže vysvětlit úkol jazykem uživatele.
Udržujte návod propojený s fungující aplikací
Podpořte první užitečnou akci. Úvodní návod nabízí novým uživatelům krátkou cestu do produktu. Měl by vysvětlit, kde začít, jaké informace jsou potřeba a jaký výsledek potvrzuje dokončení úkolu.
Vysvětlete opakující se pracovní postup. Podrobný návod se drží skutečných popisků a akcí aplikace. Předpoklady, číslované kroky a očekávaný výsledek pomáhají zopakovat obchodní úkol bez výkladu obecného popisu obrazovky.
Odpovězte na průřezovou otázku. Některé otázky se týkají účtů, nákladů nebo publikace, ne jedné obrazovky. FAQ poskytuje stručnou odpověď a odkaz na příslušný návod, takže postup zůstává na jednom místě a neopakuje se po celém webu.
Udržujte návody propojené s produktem
Po významné změně aplikace zkontrolujte dokumentaci. Návod by měl používat popisky a chování, které uživatelé skutečně vidí.
Dokumentace běží na vlastní veřejné službě. Odkažte na ni z webu a zkontrolujte návody v jazycích, ve kterých váš projekt publikuje.
Pomozte uživateli dokončit další úkol
Praktický návod vysvětluje, kde začít, jaké informace jsou potřeba a jak ověřit výsledek. Jeho hodnota spočívá v tom, že čtenáři pomáhá jednat v aplikaci.
Když úkol zasahuje do více oblastí, pokračujte s pomocí souvisejících návodů. Po změně obrazovky zkontrolujte dokumentaci, aby návody zůstaly užitečné i po vývoji aplikace.
Od dohodnutých funkcí k užitečné nápovědě
Připravte rozsah návodu. Zkontrolujte sekce dokumentace a úkoly, které mají vysvětlovat. Mějte jasno v zamýšleném uživateli a chování aplikace.
Doplňte chybějící kontext. Odpovězte na otázky k předpokladům, pravidlům a výsledkům. Text by měl používat skutečné rozhraní, ne vymyšlené ovládací prvky.
Kontrolujte po publikaci a po změně. Projděte návod v aplikaci, zkontrolujte jeho jazyky a související odkazy a vraťte se k němu, když se změní úkol, který popisuje.
Usnadněte používání produktu po první návštěvě
Poskytněte pokyny, které vedou k výsledku, vedle veřejné prezentace toho, co aplikace dělá.
Otázky k produktové dokumentaci
Stránka funkce pomáhá potenciálnímu zákazníkovi pochopit možnost a její hodnotu. Návod pomáhá uživateli provést úkol se skutečnými ovládacími prvky, předpoklady a výsledkem. Vzájemně se doplňují.
Nástroje dokumentace zobrazují definice sekcí a otázky. Zkontrolujte úkoly, které aplikace podporuje, doplňte chybějící kontext a sledujte postup psaní.
Projekt publikuje lokalizované návody dostupné pro jeho rozsah. Zkontrolujte každý publikovaný jazyk, aby si zachoval celý postup a správné popisky rozhraní.
Po změně, která ovlivní úkol, jeho ovládací prvky nebo očekávaný výsledek. Porovnejte text s fungující aplikací, místo abyste předpokládali, že původní pokyny stále platí.
Referenční dokumentace endpointů patří k projektu s aktivním, funkčním API. Používejte jeho živé operace a skutečnou referenci; plánované trasy k popisu použitelné integrace nestačí.