Technická dokumentace, návody a popisy API

Dokumentaci obvykle píše ten, kdo produkt vyvinul — a proto v ní chybí přesně ty kroky, které jsou pro autora samozřejmé a pro uživatele ne. Moje výhoda je, že produkt neznám. Projdu si ho jako nový uživatel a zapíšu i to, o čem se ve firmě nikdo nezmíní.

Píšu uživatelské příručky, návody krok za krokem, interní postupy, popisy API a texty do nápovědy v aplikaci. Kód přečtu natolik, abych se v projektu zorientoval a nemusel se vývojářů ptát na každou drobnost.

AI mi pomáhá s prvními verzemi a s hlídáním jednotnosti napříč dlouhými dokumenty. Každý postup ale procházím ručně a ověřuji, jestli podle něj někdo skutečně dojde k výsledku.

Co pro vás napíšu

• Uživatelské příručky a rychlé návody pro první spuštění
• Postupy krok za krokem se snímky obrazovky a popiskami
• Popisy API — endpointy, parametry, ukázky požadavků a odpovědí
• Interní směrnice a provozní postupy pro tým
• Nápovědu v aplikaci, chybové hlášky a texty rozhraní
• Časté dotazy sestavené z reálných dotazů zákaznické podpory

Jak pracuji

• Dostanu přístup k produktu nebo testovacímu prostředí a projdu si ho sám
• Krátký hovor s vývojářem nebo produktovým manažerem — jen na to, co nezjistím
• Navrhnu strukturu dokumentace a rozdělení na kapitoly
• Píšu v Markdownu, ve Wordu, v Confluence nebo přímo ve vašem systému
• Napsaný postup si projdu podle vlastního návodu a opravím, kde drhne

Formáty výstupu

• Markdown pro GitHub, GitBook nebo Docusaurus
• Word a PDF pro tisk a přílohy ke smlouvám
• Confluence, Notion nebo Zendesk podle toho, co používáte
• HTML nápověda vložitelná přímo do aplikace

Dokumentace zastarává rychleji než produkt sám. Proto ji píšu tak, aby se dala udržovat po částech — kapitoly jsou samostatné soubory, obrázky mají popis, kde a čím byly pořízeny. Když vydáte novou verzi, aktualizace je otázka hodin, ne přepisování celého dokumentu od začátku.