5 ukázek skutečně povedené dokumentace

19.06.2017 | Online dokumentace je standardním nástrojem pro řešení problémů- ale víte, jak ji správně tvořit?

gggJedná se o příspěvek Nilsa Biera, vedoucího týmu v K15t- jeho prací bylo to, aby pomohl týmům spolupracovat mezi sebou a sdílet znalosti. K tomu využil nástrojů Atlassian- především Confluence.

Technická dokumentace produktu ale i projektu je nedocenitelným nástrojem jak pro interní tým, tak i dané zákazníky. S tím, jak probíhá vývoj je ale nutné, aby se udržovala aktuální a vypadala profesionálně.

Společné úpravy v Confluence jsou vhodným nástrojem, jak řešit proces dokumentace vskutku agilní cestou. Ale jaká je nejlepší cesta k tomu, aby se daná dokumentace dostala tam, kam má?

Poskytování online verze je dobrý předpoklad pro dobrý zákaznický servis. Publikace online ale vyžaduje řešení dalších klíčových aspektů. To proto, aby dokumenty byly přínosem i pro značku společnosti a jejich produktu.

Co dělat pro skvělou online dokumentaci

  • Efektivita: Exportování technické dokumentace napsané v Confluence a její hostování na vašem webu by mělo být efektivním procesem (zejména pro agilní Dev týmy). Pravidlem by mělo být vyhýbat se zdvojování dokumentace, kdykoli je to možné.
  • Zůstaňte aktuální: Vaše online dokumentace musí zůstat aktuální. Nemá smysl poskytovat uživatelům nepřesnou dokumentaci. Nejlepší postup by byl, aby se dokumentace na vašich webových stránkách získala automaticky z dokumentace v Confluence.
  • Firemní design: Každé místo, které uživatelé pojí s vaší společností - včetně vašeho webu - musí dodržovat určité pokyny k návrhu. Aplikujte stejné pravidlo na online dokumentaci, abyste ji jednoznačně identifikovali a umožnili vám zvýšit brand vaší společnosti.
  • Odpovědnost: Žijeme v digitálním a mobilním světě. Vaše online dokumentace, podobně jako ostatní webové stránky, musí být responsivní, pokud chcete poskytnout zákazníkům správnou informační zkušenost napříč různými zařízeními.

5 příkladů online dokumentace

Tak, jak jde čas, je povzbudivé vidět stále více společností, které se rozhodly poskytovat uživatelům mnoho znalostí skrze technickou dokumentaci.

BMC- rychlá zpětná vazba

Všichni potřebujeme odpovědi na otázky co nejrychleji. BMC na to reaguje tím, že neustále vylepšuje svojí dokumentaci, společnost zakomponovala makra na stránkách tak, aby působily čistě a poskytovaly ten nejlepší obsah.

CA Technologies- vytváření komunity s pomocí komentářů

CA Technologies neposkytuje pouze rozšiřitelnou dokumentaci v několika jazycích a verzích, ale také nabízí uživatelům možnost komentářů. Tato funkce umožňuje ostatním u dané problematiky dopsat další, upřesňující, informace. To je další aspekt, který dokumentaci neustále vylepšuje.

iMedidata- navigací k cíli

Navigace a orientace je základním předpokladem pro spokojené uživatele. Je jasné, že tým z Medidata to moc dobře ví a vnímá- nejen, že nabízejí stromovou navigaci, ale také zkratky k relevantnímu obsahu a kotvy na stránkách- to vše pomáhá najít skutečně efektivně relevantní obsah, který hledáte.

NimbleUser- krásné a zaměřené

Na první pohled je jasné, že NimbleUser dokumentace není pouze navržena dle firemních zvyklostí, ale také má jasnou a organizovanou strukturu. To platí i pro prohlížení na mobilním zařízení.

K15t- bohatý obsah s videem

K15t Software, poskytovatel addonů pro Atlassian, využívá pro dokumentaci nástroj Confluence. Do procesu se zapojují techničtí lidé, kteří pomáhají vytvářet daný obsah. Uživatelé si mohou vybrat, zda jim vyhovuje psaný text, anebo radši video ukázky.

Za scénou

Všechny zmíněné společnosti využívají Confluence jako hlavní kanál pro dokumentaci. S možností editace a publikace přímo z Confluence odpadá duplikace obsahu v jiném CMS. Pro publikaci z Confluence přímo do svého webu se dá využít addon zvaný Scroll Viewport- ten přidává další vrstvu motivů a prvků.

Tím je umožněno dokumentaci stylizovat do potřebné podoby, ale zároveň nabídnout profesionální a responsivní design, který je plně integrovaný do vašeho webu, aniž byste museli měnit interní user interface v Confluence.


Pro další informace o novinkách Atlassian a JIRA sledujte web www.myJIRA.cz.

Diskutujeme také na LinkedIn ve skupině Atlassian komunita CZ & SK.

V případě dotazů se obraťte na atlassian_zavináč_onlio.com nebo na tel. +420222744766


Pavel Novák,
Java Developer

5 real-life examples of beautiful technical documentation, Katrina Morales, Product Marketing Manager, Marketplace, April 12, 2017
https://www.atlassian.com/blog/add-ons/5-real-life-examples-beautiful-technical-documentation

Zpět