Jak implementovat technickou dokumentaci

od ClickHelp - profesionální nástroj pro tvorbu obsahu

Téměř jakýkoli produkt má nějakou dokumentaci, která by s ním měla jít. Může to být jen varování nebo stručné pokyny k použití. A i tak by měla být osoba přidělená k psaní těchto dvou řádků, a co je důležitější, rozhodovat o tom, co má být napsáno. U složitějších produktů však musí existovat solidní uživatelská příručka. V opačném případě bude vaše podpora vybuchovat rozzlobenými hovory a zprávami od nespokojených zákazníků. Jak ale skutečně implementovat technickou dokumentaci od nuly? V tomto článku vám ukážeme obecnou představu o procesu implementace dokumentace.

Lidé

Pokud u zaměstnanců nemáte žádné technické spisovatele, můžete se k tomu vydat dvěma způsoby - najmout odborníky na plný úvazek nebo s někým uzavřít smlouvu o práci na částečný úvazek. Opravdu to záleží na pracovní zátěži. Pro některé společnosti má větší smysl mít dodavatele na částečný úvazek.

Pokud bude váš projekt technické dokumentace velmi velký a bude vyžadovat neustálou aktualizaci a údržbu, měli byste opravdu přemýšlet o tom, že budete mít vlastní dokumentační tým. Tento přístup samozřejmě vyžaduje spoustu času a zdrojů, ale na konci dne budete mít tým profesionálů, kteří znají váš produkt jako zadní část jejich ruky.

Proces

V tomto kroku se budete muset v zásadě oženit se svými technickými a dokumentačními procesy, pokud jde o plánování, časové harmonogramy a výsledky. Od nynějška musí být odborní spisovatelé pozváni na všechny plánovací diskuse a technická setkání, protože dokumentace musí být aktuální. U každého nového vydání produktu by mělo být také vydání od týmu dokumentace. Udržování aktualizované dokumentace může být velkým přínosem, pokud jde o vychýlení případu a úspěšnost vašich zákazníků s výrobkem.

Formát

Formát uživatelské příručky závisí na odvětví, ve kterém se nacházíte. Technická dokumentace může být dodána spolu s vaším produktem jako tištěná uživatelská příručka nebo například na CD. Pokud je to možné, zvažte formát online dokumentace. V dnešní době si většina společností zvolila formát svého výběru. A existuje mnoho důvodů. První a nejdůležitější - taková dokumentace je v Googlu snadno vyhledatelná. Všichni vaši uživatelé budou potřebovat prohlížeč a připojení k internetu, aby získali odpovědi.

Webová řešení mají co nabídnout. Když spustíte online dokumentační portál, váš marketingový tým okamžitě pocítí výhody dalšího vystavení na webu. Svého online uživatelského průvodce můžete proměnit v silný marketingový nástroj pomocí značky, klíčových slov a vyhledávání.

Pokud se chcete dozvědět více o výhodách zveřejňování vaší dokumentace online, podívejte se na tento příspěvek s názvem „18 miliard důvodů“.

Nástroje

Jakmile zjistíte formát dokumentace a sestavíte tým, je čas hledat vhodné nástroje.

Naštěstí existuje spousta připravených řešení, mimo jiné HAT, nebo pomoc při vytváření nástrojů. Jedná se o speciální nástroje vyvinuté pro technické spisovatele a jsou mnohem více než jen software pro editaci textu. Většina moderních řešení pro technické spisovatele je velmi flexibilní, což znamená, že budete moci přizpůsobit nástroj vašim konkrétním potřebám.

Nástroje pro tvorbu obsahu, jako je ClickHelp, obsahují funkce pro uspořádání pracovního postupu tak, jak pro vás funguje. Uživatelům lze například přiřadit různé role, existují e-mailová oznámení, stavy témat, funkčnost procesu kontroly a další. Nástroj tedy můžete buď upravit, nebo postavit zcela nový pracovní proces na základě funkcí, které vaše řešení pro tvorbu obsahu nabízí.

Závěr

Takto je technická dokumentace implementována obecně. Celý tento proces je samozřejmě ve skutečnosti mnohem složitější. V tomto článku jsme se zabývali pouze některými vysokými úrovněmi implementace uživatelské příručky. Doufáme, že tento příspěvek vám pomůže vidět celý obrázek, a odtud se budete moci přesunout k vážnějším podrobným informacím a stát se úspěšnými při organizaci a přijímání pomoci při vytváření procesů ve vaší společnosti.

Hodně štěstí při technické kariéře psaní!
ClickHelp Team
Autor, hostitel a doručovat dokumentaci napříč platformami a zařízeními

Původně zveřejněno na clickhelp.co.