Dokumentace

Kvalitně zpracovaná dokumentace snižuje náklady na zaškolení, na přímou podporu uživatelů i na nasazení systému. ...


Kvalitně zpracovaná dokumentace snižuje náklady na zaškolení, na přímou podporu
uživatelů i na nasazení systému.
Ta tam je doba, kdy uživateli stačilo pár kliků a cítil se v aplikaci jako
doma. Vyvíjené a nabízené softwarové produkty jsou dnes již tak komplexní a
sofistikované, že si lze jen stěží představit ideál uživatele "proklikávajícího
se" aplikací zcela suverénně a efektivně. Dnes se zdá, že stále potřebnější a
nakonec taky výhodnější je naučit zákazníka-uživatele software používat,
přiblížit mu jeho přednosti, a tím nový software skutečně zpopularizovat a
prodat. A právě tam, kde končí intuice běžného uživatele, začíná práce
profesionálního dokumentaristy. U softwarových produktů, především těch, co
profesionální konzultační firmy připravují svým zákazníkům na míru, se lze
občas setkat s jevem, že jakákoliv dokumentace k softwaru nebo k informačnímu
systému chybí. Někdy je tato dokumentace neúplná, což ji ale přesto činí
bezcennou, neboť v problémovém okamžiku strohá příručka či manuál zpravidla
nepomůžou.
Rostoucí komplexnost
Především kvůli rychle vzrůstající složitosti informačních systémů a jejich
vzájemné provázanosti ve velkých společnostech je stav dokumentačního
vzduchoprázdna neudržitelný. Významní zákazníci renomovaných softwarových firem
si uvědomují, že mají příliš vysoké náklady na zpětnou analýzu dodávaných
systémů v případě změn a úprav a stejně tak na proces zaškolování nových
uživatelů. Prevencí těchto potíží je tedy kvalitně zpracovaná dokumentace.
Dokumentování postupně zraje v samostatnou disciplínu v rámci IT, která
samozřejmě využívá moderních přístupů oboru, jemuž slouží. Samotná činnost
dokumentování obecně spadá pod širší pojem ve světě známý Technical Writing.
Kurzy Technical Writing vypisují vybrané americké univerzity a na internetu lze
v různých částech světa vystopovat celá sdružení dokumentaristů, která pořádají
odborná sympozia, organizují elektronické konference, spravují knowledge base
oboru nebo nabízejí získání certifikátů. Dokumentaci dnes nepíší vývojáři ani
analytici, nýbrž dokumentaristé. Jsou to profesionálové, kteří vlastní
know-how, zvládají nástroje a především rozumí jazyku na všech rovinách.
Tištěně nebo elektronicky
Zatímco dřívější podobou dokumentace byl bezesporu tištěný manuál, který
zpravidla nikdo nechtěl číst, dnes je mnohem důležitější dokumentaci nabízet i
jinými způsoby on-line na webu či přímo v aplikaci v podobě nápovědy. Příručky
vytvářené a dodávané tímto způsobem značně usnadňují práci, neboť je v nich
jednoduché provádět aktualizace. V dnešní době, kdy se specializované firmy
předhání v inovování verzí již hotových softwarových produktů, je toto
rozhodující předností. Interaktivní pojetí on-line příručky je výhoda, díky níž
uživatel zapomene na fádnost a nudnost tradičních tištěných materiálů. V takové
příručce nemusí zdlouhavě číst a listovat, nýbrž chová se tak, jak je zvyklý na
webových stránkách. Jednotlivé stránky spíš skenuje, než aby je četl. Velice
rychle dokáže pomocí hypertextových odkazů, systému rejstříku i fulltextového
vyhledávání nalézt přesně to, co potřebuje. Stylová grafika a do detailu
"nasnímané" obrázky mu také pomáhají zvládat dané problémy. Proces dokumentace
Bez dobré dokumentace by pro mnoho uživatelů byla většina softwaru téměř
nepoužitelná. Samo dokumentování by mohlo někomu připadat banální, neboť
nástrojů na tvorbu dokumentace existuje dnes relativně mnoho a vše nasvědčuje
tomu, že i další vývoj se bude posouvat směrem k co největší automatizaci
tohoto procesu tedy k co největší úspoře času a peněz. Je však zvládnutí
nějakého nástroje skutečným těžištěm práce profesionálního dokumentaristy?
Nenechte se zmýlit. Nejdůležitějším předpokladem pro vytvoření opravdu dobré
dokumentace je jednak hluboká znalost popisovaného softwaru, a také schopnost
sepsání srozumitelného a logicky členěného výkladu. A v tom vám žádná
technologie příliš nepomůže. Není divu, že zákazníci, kteří vyžadují opravdu
profesionální kvalitu svých příruček, se stále častěji obracejí na specialisty
této profese.
Tito specialisté, soustředěni převážně v konzultačních firmách, se opírají o
praxí zdokonalované know-how, pracují s odpovídajícími nástroji a používají
osvědčené metodiky. Důležitá je gramatická, stylistická i funkční správnost
jejich příruček. Práce dokumentaristy je navíc o to těžší, že často pracuje
ještě s "živým" materiálem. Bývá zvykem, že se dokumentarista stává součástí
projektového týmu většinou až v poslední fázi vývoje produktu, kdy probíhá
testování a zapracování změn. Aplikace, již tento člověk popisuje, se mu tak
nezřídka mění pod rukama. A zde lze nalézt další přidanou hodnotu
dokumentaristické práce. Kontrolní funkce
Dokumentarista může v projektovém týmu zastávat roli konečného "verifikátora"
produktu při své práci například ověřuje, zda jsou pole popisovaného formuláře
správně označena. Může se totiž stát, že aniž by došlo k zaznamenání změn,
konečný produkt v detailech neodpovídá počáteční schválené analýze. Má-li však
mít zákazník-uživatel z práce dokumentaristy opravdu užitek, je třeba na
všechny změny pružně reagovat a finální dokumentaci přizpůsobit skutečnému
stavu. Stěží si představíme situaci, že dokumentarista při své práci vychází
pouze z analytických materiálů a specifikací a na aplikaci se ani nepodívá.
Pro dokumentaci je vždy lepší, vzniká-li iterativním způsobem, což znamená, že
dokud není přijatá její konečná verze, podléhá připomínkování ze strany
zadavatele. Ten má tak ještě v průběhu vzniku dokumentace možnost ovlivnit její
finální podobu. Poté, co je příručka logicky sepsána a obsahově precizována,
nemá dokumentarista problém nabídnout zákazníkovi různé výstupní formáty
dokumentace, přesně dle jeho potřeb. Mezi ty nejběžnější patří kompilovaný HTML
Help 1.x (formát CHM), MS Help 2.x, JavaHelp, internetová verze nápovědy
(formát HTML), dokumenty MS Word (formát DOC), dokumenty Adobe Acrobat (formát
PDF), nápověda pro mobilní zařízení (Pocket PC) apod. Dokumentační možnosti
Firmy, které nabízejí vlastní softwarová řešení, se pravděpodobně mohou obávat
o zastupitelnost svých klíčových zaměstnanců či celých vývojových týmů. Dobře
dělaná dokumentace by proto měla postihovat všechny fáze vývoje produktu: od
dokumentace programové, přes zevrubnou administrátorskou umožňující
bezproblémové nasazení, parametrizaci a provoz systémů až k dokumentaci
uživatelské. Uživatelská dokumentace většinou obsahuje detailní uživatelský
popis aplikace (systému), který je rozdělen do dvou hlavních bloků. Prvním
blokem je referenční popis uživatelského rozhraní, včetně všech ovládacích
prvků, jejich významu a způsobu použití. Za ním následuje blok uživatelských
postupů, jenž uživatele, zpravidla dle uživatelských rolí, provádí všemi
typickými pracovními postupy a hlavními procesy. Pracovní postupy jsou
uživatelům popisovány jasně, za použití jednotné a srozumitelné terminologie.
Další typy dokumentací
Administrátorskou a provozní dokumentaci představují zpravidla více
strukturované příručky, které obsahují popis instalace a konfigurace dodávaného
systému, popisy dat a jejich struktury, charakteristiky pracovních tabulek a
popis úložišť, seznam transformačních prací, pravidla pro zálohování, pravidla
pro bezpečnost systému, pravidla pro sledování systému a další informace nutné
pro bezproblémové nasazení, udržování a chod aplikace (systému).
Přesné a důkladné komentování programového kódu vývojáři je zase podkladem pro
programovou a technickou dokumentaci, umožňující vzájemnou zastupitelnost členů
týmu i pozdější pokračování ve vývoji aplikace či systému.
Autor pracuje na pozici senior dokumentaristy ve společnosti Adastra.
(pal) 6 1437









Komentáře
K tomuto článku není připojena žádná diskuze, nebo byla zakázána.