Krok za krokom sprievodca, ako vytvoriť a spravovať dokumentáciu produktu | Správa produktu #31

Čo je dokumentácia produktu?

Dokumentácia produktu je zbierka textu, vizuálov a videí, ktoré popisujú produkt, jeho funkcie, spôsob, akým by sa mal používať, a ďalšie relevantné detaily. Hlavným cieľom vytvárania dokumentácie je pomôcť používateľom pochopiť, ako používať produkt, a najmä jeho pokročilé funkcie.

Dokumentácia je dôležitá, najmä ak vytvárate digitálny produkt, ktorý bude slúžiť nielen koncovým používateľom, ale aj integrovať sa s inými produktmi – napríklad umožňujúc vám exportovať údaje do inej aplikácie alebo používať lokalizačnú alebo kontaktnú databázu.

Dokumentácia pre nástroj na riadenie projektov môže napríklad obsahovať informácie o tom, ako vytvoriť nový projekt, ako pridať členov tímu do projektu a dať im povolenie meniť iba určité úlohy, ako priradiť úlohy viacerým ľuďom súčasne a ako sledovať ich pokrok.

Prvky dokumentácie produktu

Dokumentácia produktu môže obsahovať:

• Príručka pre používateľa – dokument, ktorý poskytuje informácie o funkciách produktu, inštalácii, nastaveniach a riešení problémov.
• Sprievodca pre používateľa – dokument, ktorý vysvetľuje, ako vykonávať rôzne úlohy s produktom, ako napríklad, ako používať program na úpravu fotografií alebo ako hrať počítačovú hru.
• Vedomostná základňa – zbierka článkov alebo webových stránok, ktoré odpovedajú na často kladené otázky alebo poskytujú ďalšie informácie o produkte. Príkladom by mohla byť sekcia “Centrum pomoci” alebo “Podpora” na webovej stránke. Často sa tiež používa ako zdroj informácií pre chatbot, ktorý pomáha zákazníkom.
• Často kladené otázky (FAQ) – zoznam často kladených otázok a odpovedí o produkte. Napríklad webová stránka alebo PDF súbor, ktorý obsahuje odpovede na otázky ako: “Ako si resetujem heslo?”, “Ako kontaktujem zákaznícku podporu?” alebo “Aké sú systémové požiadavky pre produkt?”.
• Výukové programy – videá, zvyčajne zverejnené na webovej stránke spoločnosti alebo na YouTube, ktoré demonštrujú, ako používať produkt alebo vykonávať určité úlohy.
• Diagramy a infografiky – grafické znázornenia štruktúry, funkcie alebo procesu produktu. Napríklad diagram, ktorý ukazuje, aké možnosti vybrať pri konfigurácii API.

Ako vytvoriť dokumentáciu produktu?

Pochopenie cieľovej skupiny

Prvým krokom pri vytváraní dokumentácie produktu je pochopiť publikum, ktorému bude tento konkrétny dokument určený. Odpovedzte na nasledujúce otázky:

• Kto bude tento dokument používať? – Bude to používateľ, ktorý ho používa prvýkrát, alebo pokročilý používateľ?
• V akom momente si používateľ siahne po tomto dokumente? Hľadá všeobecné alebo dodatočné informácie o schopnostiach nástroja, alebo riešenie konkrétneho problému?
• Na akom zariadení ho bude používať? Ak ide o mobilné zariadenie, sú videá dostatočne jasné?
• Aké sú ich potreby a očakávania? Uprednostní používateľ sledovanie dynamického videa alebo pohľad na diagram?

Akonáhle pochopíte svoje publikum a jeho potreby, môžete začať vytvárať svoju dokumentáciu. Napríklad, ak je vaša cieľová skupina noví používatelia, dokumentácia by mala byť prístupná na každom kroku, napísaná jednoduchým, ľahko pochopiteľným jazykom a obsahovať podrobné pokyny.

Nezabúdajte, že dobre organizovaná dokumentácia nielen pomáha používateľom pochopiť produkt, ale tiež šetrí čas, ktorý by mohli stráviť hľadaním odpovedí na svoje otázky. To znižuje odliv, teda percentuálny podiel zákazníkov, ktorí prestanú odoberať službu.

Jasná komunikácia

Vytváranie efektívnej dokumentácie produktu nie je len o výbere správnej formy komunikácie (napr. videá, vizuály, vedomostná základňa), ale aj o písaní a komunikovaní jasne a stručne. Základné princípy efektívnej komunikácie v dokumentácii produktu sú nasledujúce:

• Používajte jednoduchý jazyk – vyhnite sa technickému jazyku a zložitým termínom. Napríklad namiesto toho, aby ste povedali “iniciovať projekt,” môžete povedať “začať projekt.”
• Buďte konkrétni – poskytnite príklady, aby ste pomohli používateľom pochopiť, ako používať produkt. Napríklad namiesto toho, aby ste povedali “umožňuje vám pridať členov tímu do projektu,” povedzte “pridajte člena tímu do projektu kliknutím na zelené tlačidlo na spodnej časti stránky riadenia projektu” a pridajte snímku obrazovky s vizuálnym náznakom.
• Vyhnite sa pasívnemu hlasu – aktívny hlas je ľahšie pochopiteľný a čitateľný. Napríklad namiesto toho, aby ste povedali “projekt môže byť začatý manažérom,” povedzte “manažér môže začať projekt.”

Existuje mnoho ďalších princípov, ktorými sa treba riadiť, ale najdôležitejšie je pamätať na to, že efektívna dokumentácia produktu by mala byť zrozumiteľná pre používateľov a pomôcť im efektívne používať produkt.

Používanie vizuálov v dokumentácii produktu

Vizuály, ako sú obrázky, gif, krátke videá, diagramy a infografiky, môžu výrazne zlepšiť pochopenie dokumentácie produktu. Napríklad snímka obrazovky, ktorá ukazuje, kde sa nachádza tlačidlo “Pridať člena tímu” na stránke, môže byť veľmi užitočná pre používateľov, ktorí ho používajú prvýkrát. Pri vytváraní dokumentácie tiež používajte jasné nadpisy a jednoduché písmo na organizovanie textu.

Aktualizácia a údržba dokumentácie produktu

Dokumentácia produktu nie je statický dokument. Musí sa pravidelne aktualizovať, aby odrážala zmeny v produkte. Pravidelné aktualizácie sú kľúčové pre to, aby dokumentácia plnila svoj účel. Napríklad, ak zavádzate novú funkciu do svojho softvéru na riadenie projektov, mali by ste aktualizovať jeho dokumentáciu produktu, aby to zohľadnila.

Publikovanie a distribúcia dokumentácie produktu

Publikovanie a distribúcia dokumentácie produktu je rovnako dôležité ako jej vytváranie. Musíte sa uistiť, že vaša dokumentácia je používateľom ľahko prístupná, bez ohľadu na to, kde sa nachádzajú alebo aké zariadenie používajú. Napríklad môžete nahrať svoju dokumentáciu produktu na svoju webovú stránku alebo ju poslať priamo používateľom e-mailom.

Najlepšie systémy správy dokumentov pre produktových manažérov

Produktoví manažéri majú k dispozícii mnoho nástrojov, ktoré im môžu pomôcť vytvárať a spravovať dokumentáciu produktu. Medzi populárne riešenia patrí:

• Google Docs je cloudová služba na vytváranie a úpravu dokumentov. Je to populárny nástroj pre produktových manažérov, pretože k nemu máte prístup na akomkoľvek zariadení a môžu ho používať viacerí členovia tímu.

• Firmbee je komplexný nástroj na riadenie projektov a tímov, ktorý umožňuje používateľom vykonávať úlohy z akéhokoľvek miesta na svete v reálnom čase. Produktoví manažéri môžu ľahko organizovať svoju prácu a prácu svojich kolegov, sledovať pokrok, kontrolovať rozpočty a vykonávať náborové procesy.

• Notion je aplikácia na riadenie úloh a projektov, ktorá sa môže používať na sledovanie úloh, poznámok a súborov. Notion je populárna voľba pre produktových manažérov, pretože je flexibilná a môže byť prispôsobená.

• Zendesk Guide je riešenie pre zákaznícku podporu, ktoré sa môže používať na vytváranie a zdieľanie článkov vedomostnej základne. Zendesk Guide je populárna voľba pre produktových manažérov, pretože im umožňuje poskytovať podporu a pomáhať zákazníkom riešiť ich problémy.

Zhrnutie

Vytváranie a správa dokumentácie produktu je často podceňovaná úloha. Mnohí vývojári digitálnych produktov veria, že dobre navrhnutý produkt je samozrejmý. Avšak dokumentácia produktu by mala byť viac než len sprievodca pre používateľa.

Mal by to byť aj nástroj, ktorý môže pomôcť zvýšiť povedomie zákazníkov o produkte a analyzovať ich záujem o nové funkcie, ako aj počet zobrazení konkrétnych článkov alebo vysvetlení. Takáto analýza pomáha spoločnostiam lepšie spravovať svoje produkty a zlepšovať používateľskú skúsenosť. Takže stojí za to venovať čas a úsilie na vytvorenie efektívnej dokumentácie produktu, ktorá môže slúžiť vám aj vašim používateľom.

Ak sa vám náš obsah páči, pridajte sa k našej komunite usilovných včiel na Facebooku, Twitteri, LinkedIn, Instagrame, YouTube, Pinterest, TikTok.