Jste začínajícím technickým spisovatelem, který chce teprve začít, ale neví, které nástroje pro dokumentaci svých textů použít? Tak to jste na správném místě!
Především si ujasněme, co přesně je technická dokumentace
Člověk potřebuje zdokumentovat svůj postup, a proto je technický dokument považován za jeden z důležitých faktorů, které přispívají k úspěchu softwarového projektu.
Technický dokument by neměl vyžadovat doktorát, abyste mu porozuměli, jednodušeji řečeno a z hlediska techniky se technickou dokumentací rozumí jakýkoli typ dokumentace, který popisuje zacházení, funkčnost a architekturu technického produktu nebo jakéhokoli jiného produktu, který je ve vývoji nebo v provozu.
Dokumentace může sahat od jednostránkového listu s požadavky až po tlustou referenční příručku dokumentující nový open-source framework.
Dnes je dokumentace k aplikacím, rozhraním API, sadám SDK a dokonce i k většině hardwarových produktů dostupná online.
Uvedl jsem seznam nejlepších nástrojů pro technickou dokumentaci spolu s odkazy, abyste se v nich mohli zorientovat a lépe jim porozumět, tak začneme, ne?
HelpNDoc je snadno použitelný, ale výkonný autorský nástroj, který je univerzální pro vaše různé potřeby, dokáže generovat různé formáty dokumentace z jediného zdroje.
HelpNDoc poskytuje všechny nástroje potřebné k psaní kompletních souborů nápovědy, příruček a dokumentace v uživatelsky přívětivém a velmi snadno použitelném prostředí.
Může vytvářet standardní soubory nápovědy CHM systému Windows, dokumentaci založenou na WEBu, webové stránky specifické pro iPhone a také tisknutelné dokumenty PDF a Word.
Funkce
– HelpNDoc umožňuje pisateli vytvořit jediný zdrojový text, který pak převede do řady cílových formátů, jako je nápověda HTML, PDF, RTF, DocX, nápověda Qt a dokumentace HTML a také elektronické knihy kompatibilní s EPUB a Amazon Kindle.
– Má také možnost generovat kód pro programovací jazyky C++, Delphi, Fortran, Pascal a Visual Basic pro integraci vygenerovaných souborů nápovědy CHM s vyvíjenou aplikací.
– Od verze 4 je HelpNDoc vybaven analyzátorem projektu, který dokáže sledovat rozvržení dokumentu, poskytovat statistiky a identifikovat potenciální problémy, jako jsou nefunkční odkazy nebo problémy s mediálními položkami.
- HelpNDoc lze také použít k publikování mobilních webových stránek s využitím obsahu jako navigační nabídky, obsahu témat s navigačními tlačítky, nabídky rejstříku klíčových slov, vestavěného vyhledávače a prvků uživatelského rozhraní specifických pro mobilní zařízení.
https://www.helpndoc.com/
#2 ClickHelp
Potřebujete dokumentační nástroj s řadou funkcí, pak je ClickHelp tím pravým pro vás. ClickHelp je moderní dokumentační nástroj založený na prohlížeči, který se snadno nastavuje a používá, nevyžaduje instalaci, běží ve webovém prohlížeči a podporuje více platforem:
Softwarové společnosti po celém světě používají ClickHelp k vytváření online uživatelských příruček, znalostních databází, souborů nápovědy, často kladených otázek a návodů a okamžitě je publikují na svém portálu.
Funkce
-Denní zálohování- ClickHelp poskytuje denní zálohování, takže máte jistotu, že jsou vaše data v bezpečí
-Pokročilá analytika- ClickHelp má vlastní integrovanou analytiku, která vám pomáhá analyzovat aktuální situaci a pomáhá také plánovat proces dokumentace dopředu.
-Lidsky čitelné adresy URL projektu- Funkce užitečná nejen pro lidi, ale také pro vyhledávače, tato funkce pomáhá při SEO vaší dokumentace
-Tlačítka pro sdílení na sociálních sítích- Snadno sdílejte svou dokumentaci na různých sociálních sítích.
-Poznámky k recenzím témat- Revize je fáze v procesu psaní dokumentace, kterou nemůže vynechat žádný tým. ClickHelp nabízí nejen funkci poznámek k recenzím, ale také speciální roli recenzenta.
-Výkonný editor témat- Každý autor technických textů má rád dobrý textový editor, ClickHelp nabízí funkce podobné Wordu a další funkce, které vám poskytnou pohodlné pracovní prostředí.
- Integrace- ClickHelp má působivé možnosti integrace, například : Zendesk, AddThis, Disqus, Google Analytics, Google Search Console, Azure AD SSO, Google SSO, Salesforce SSO, YouTube, Vimeo, Gravatar, Screencast.com atd.
https://clickhelp.com/
#3 Whatfix
Chcete vytvořit interaktivního průvodce na své platformě? Whatfix je pro vás ten správný nástroj.
Whatfix je platforma pro digitální adopci, která pomáhá podnikům zavádět, školit a podporovat uživatele jejich aplikací.
Whatfix umožňuje vytvářet a poskytovat kontextový a přizpůsobený obsah formou toků, tipů nápovědy, videí, odkazů a textů, a to vše jako zážitek v aplikaci
Whatfix lze použít k vytváření obsahu v jakékoli webové podnikové aplikaci, jako jsou Salesforce, SAP SuccessFactors, Oracle HCM Cloud atd. vlastní webové aplikace a na webových stránkách zaměřených na spotřebitele.
Společnost Whatfix navíc podporuje jak cloudové, tak samohostitelské režimy nasazení.
Funkce
-Kompatibilita s rozhraním API pro více prohlížečů
-Interaktivní uživatelské příručky
-Samohostitelské nasazení
-Datová analýza
-Sledování uživatelů
-Více formátů příruček včetně videí, grafiky, obrázků a textů.
-Přizpůsobitelné uživatelské rozhraní
#4 ProcessStreet
ProcessStreet je nejjednodušší způsob správy opakujících se pracovních postupů pro váš tým. Navíc pomáhá rychle přiřadit kontrolní pracovní postupy vašemu týmu.
ProcessStreet má jednoduché rozhraní, které vám pomůže vytvořit strukturovaný dokument během několika sekund. Navíc můžete sledovat aktivitu z ovládacího panelu a upozorňuje na splnění úkolů.
Je domovem pro procesní dokumenty vašeho týmu, jejich intuitivní klávesové zkratky a přetahování usnadňují používání každému.
Funkce
-Podmíněná logika- Pomocí podmíněné logiky můžete vytvářet skutečně dynamické kontrolní seznamy s logikou if/then, která se přizpůsobuje měnícím se potřebám vašich týmů.
-Použití formulářů pro sběr strukturovaných dat- Pomocí formulářů můžete v kontrolních seznamech shromažďovat strukturovaná data. Vkládejte data ručně nebo je nechte odesílat do vybraných aplikací a z nich.
-Pracovní postup založený na pravidlech
-Společný pracovní prostor
Na závěr
Pro různé typy technické dokumentace jsou k dispozici různé softwarové nástroje, výběr závisí na vaší cílové skupině. Musíte si osahat ten, který vás nejvíce láká, a prostě se do něj pustit, jakmile začnete, vždy se můžete rozhodnout, který je pro vás ideální!