Krok za krokem průvodce, jak vytvořit a spravovat dokumentaci k produktu | Řízení produktu #31

Co je dokumentace produktu?

Dokumentace produktu je soubor textu, vizuálů a videí popisujících produkt, jeho funkce, způsob použití a další relevantní detaily. Hlavním cílem vytváření dokumentace je pomoci uživatelům pochopit, jak produkt používat, a zejména jeho pokročilé funkce.

Dokumentace je důležitá, zejména pokud vytváříte digitální produkt, který bude sloužit nejen koncovým uživatelům, ale také se integrovat s jinými produkty – například umožňující export dat do jiné aplikace nebo použití lokalizační nebo kontaktní databáze.

Například dokumentace pro nástroj pro řízení projektů může zahrnovat informace o tom, jak vytvořit nový projekt, jak přidat členy týmu do projektu a udělit jim oprávnění měnit pouze určité úkoly, jak přiřadit úkoly více lidem současně a jak sledovat jejich pokrok.

Prvky dokumentace produktu

Dokumentace produktu může zahrnovat:

• Uživatelská příručka – dokument, který poskytuje informace o funkcích produktu, instalaci, nastavení a odstraňování problémů.
• Uživatelský průvodce – dokument, který vysvětluje, jak provádět různé úkoly s produktem, například jak používat program pro úpravu fotografií nebo jak hrát počítačovou hru.
• Knowledge base – sbírka článků nebo webových stránek, které odpovídají na často kladené otázky nebo poskytují další informace o produktu. Příkladem by mohla být sekce “Centrum nápovědy” nebo “Podpora” na webových stránkách. Je také často používána jako zdroj informací pro chatbot, který pomáhá zákazníkům.
• FAQ – seznam často kladených otázek a odpovědí o produktu. Například webová stránka nebo PDF soubor, který obsahuje odpovědi na otázky jako: “Jak mohu resetovat své heslo?”, “Jak mohu kontaktovat zákaznickou podporu?” nebo “Jaké jsou systémové požadavky na produkt?”.
• Tutorialy – videa, obvykle zveřejněná na webových stránkách společnosti nebo YouTube, která ukazují, jak používat produkt nebo provádět určité úkoly.
• Diagramy a infografiky – grafické znázornění struktury, funkce nebo procesu produktu. Například diagram ukazující, jaké možnosti vybrat při konfiguraci API.

Jak vytvořit dokumentaci produktu?

Pochopení cílové skupiny

Prvním krokem při vytváření dokumentace produktu je pochopit publikum, kterému bude tento konkrétní dokument určen. Odpovězte na následující otázky:

• Kdo bude tento dokument používat? – Bude to nováček nebo pokročilý uživatel?
• V jakém okamžiku si uživatel sáhne po tomto dokumentu? Hledají obecné nebo dodatečné informace o schopnostech nástroje, nebo řešení konkrétního problému?
• Na jakém zařízení ho budou používat? Pokud je to mobilní zařízení, jsou videa dostatečně jasná?
• Jaké jsou jejich potřeby a očekávání? Bude uživatel preferovat sledování dynamického videa nebo pohled na diagram?

Jakmile pochopíte své publikum a jeho potřeby, můžete začít vytvářet svou dokumentaci. Například, pokud je vaše cílová skupina nováčci, měla by být dokumentace přístupná na každém kroku, napsaná jednoduchým, snadno srozumitelným jazykem a obsahovat podrobné pokyny.

Pamatujte, že dobře organizovaná dokumentace nejen pomáhá uživatelům pochopit produkt, ale také šetří čas, který by mohli strávit hledáním odpovědí na své otázky. To snižuje odliv, tedy procentuální míru, jakou zákazníci přestávají odebírat službu.

Jasná komunikace

Vytváření efektivní dokumentace produktu není jen o výběru správné formy komunikace (např. videa, vizuály, knowledgebase), ale také o psaní a komunikaci jasně a stručně. Základní principy efektivní komunikace v dokumentaci produktu jsou následující:

• Používejte jednoduchý jazyk – vyhněte se technickému jazyku a složitým termínům. Například místo “zahájit projekt” můžete říci “spustit projekt”.
• Buďte konkrétní – poskytněte příklady, které pomohou uživatelům pochopit, jak produkt používat. Například místo “umožňuje přidat členy týmu do projektu” řekněte “přidejte člena týmu do projektu kliknutím na zelené tlačítko na spodní části stránky pro řízení projektů” a přidejte snímek obrazovky s vizuálním návodem.
• Vyhněte se pasivnímu hlasu – aktivní hlas je snazší pochopit a číst. Například místo “projekt může být zahájen manažerem” řekněte “manažer může projekt zahájit.”

Existuje mnoho dalších principů, kterými se řídit, ale nejdůležitější je pamatovat, že efektivní dokumentace produktu by měla být srozumitelná uživatelům a pomoci jim efektivně používat produkt.

Používání vizuálů v dokumentaci produktu

Vizuály, jako jsou obrázky, gify, krátká videa, diagramy a infografiky, mohou výrazně zlepšit pochopení dokumentace produktu. Například snímek obrazovky ukazující, kde se nachází tlačítko “Přidat člena týmu” na stránce, může být velmi užitečný pro nováčky. Při vytváření dokumentace také používejte jasné nadpisy a jednoduché písmo k organizaci textu.

Aktualizace a údržba dokumentace produktu

Dokumentace produktu není statický dokument. Musí být pravidelně aktualizována, aby odrážela změny v produktu. Pravidelné aktualizace jsou klíčové pro to, aby dokumentace plnila svůj účel. Například, pokud zavádíte novou funkci do svého softwaru pro řízení projektů, měli byste aktualizovat jeho dokumentaci produktu, aby to zohlednila.

Publikování a distribuce dokumentace produktu

Publikování a distribuce dokumentace produktu je stejně důležité jako její vytváření. Musíte zajistit, aby byla vaše dokumentace snadno dostupná uživatelům, bez ohledu na to, kde se nacházejí nebo jaké zařízení používají. Například můžete nahrát svou dokumentaci produktu na své webové stránky nebo ji poslat přímo uživatelům e-mailem.

Nejlepší systémy pro správu dokumentů pro produktové manažery

Produktoví manažeři mají k dispozici mnoho nástrojů, které jim mohou pomoci vytvářet a spravovat dokumentaci produktu. Mezi populární řešení patří:

• Google Docs je cloudová služba pro vytváření a úpravu dokumentů. Je to oblíbený nástroj pro produktové manažery, protože k němu máte přístup na jakémkoli zařízení a mohou ho používat více členů týmu.

• Firmbee je komplexní nástroj pro řízení projektů a týmů, který umožňuje uživatelům plnit úkoly odkudkoli na světě v reálném čase. Produktoví manažeři mohou snadno organizovat svou práci a práci svých kolegů, sledovat pokrok, kontrolovat rozpočty a provádět náborové procesy.

• Notion je aplikace pro správu úkolů a projektů, která může být použita k sledování úkolů, poznámek a souborů. Notion je oblíbenou volbou pro produktové manažery, protože je flexibilní a lze ji přizpůsobit.

• Zendesk Guide je řešení pro zákaznický servis, které může být použito k vytváření a sdílení článků knowledge base. Zendesk Guide je oblíbenou volbou pro produktové manažery, protože jim umožňuje poskytovat podporu a pomáhat zákazníkům řešit jejich problémy.

Shrnutí

Vytváření a správa dokumentace produktu je často podceňovaná úloha. Mnoho vývojářů digitálních produktů věří, že dobře navržený produkt je samozřejmý. Nicméně, dokumentace produktu by měla být více než jen uživatelský průvodce.

Měla by být také nástrojem, který může pomoci zvýšit povědomí zákazníků o produktu a analyzovat jejich zájem o nové funkce, stejně jako počet zobrazení konkrétních článků nebo vysvětlení. Taková analýza pomáhá firmám lépe spravovat své produkty a zlepšovat uživatelskou zkušenost. Takže stojí za to věnovat čas a úsilí k vytvoření efektivní dokumentace produktu, která může sloužit jak vám, tak vašim uživatelům.

Pokud se vám náš obsah líbí, připojte se k naší komunitě pracovních včel na Facebooku, Twitteru, LinkedInu, Instagramu, YouTube, Pinterestu, TikToku.