Uživatelská dokumentace
Administrátorské a provozní příručky
Technická a programová dokumentace
Uživatelská dokumentace
Uživatelská dokumentace obsahuje detailní uživatelský popis aplikace/systému, zpravidla složený ze dvou hlavních bloků:
| ▪ | Referenční popis uživatelského rozhraní, včetně všech základních objektů a ovládacích prvků, jejich významu a způsobu použití (připravený též pro kontextovou nápovědu); |
| ▪ | Popis uživatelských postupů, jenž provede uživatele (dle rolí) všemi základními postupy a procesy v aplikaci/systému. |
Uživatelská dokumentace je rozdělena do vzájemně navazujících kapitol. Tím je umožněno vytištění dokumentace jako běžného manuálu. Pomocí hypertextových odkazů lze příslušný oddíl dokumentace otevřít okamžitě, aniž by bylo nutné prohlížet jednotlivé stránky před vybraným místem.
Dokumentace je bohatě vybavena obrázky, postihujícími dané situace. Jednotlivé obrázky na sebe logicky navazují.
Dokumentaci lze chápat jako interaktivní nápovědu aplikace, zároveň je však i strukturovaným manuálem.
 | | Ukázka uživatelské dokumentace |
|
Administrátorské a provozní příručky
Administrátorské a provozní příručky jsou strukturované příručky určené administrátorům a operátorům systému.
Příručky obsahují zpravidla tyto základní bloky:
| ▪ | Definice základních pojmů - Slovník pojmů a zkratek použitých v příručce, jejichž znalost je nutná pro pochopení obsahu; |
| ▪ | Charakteristika a popis systému - Seznamuje s jednotlivými součástmi systému (Aplikační architektura, Integrační architektura, Infrastruktura, ...); |
| ▪ | Popis instalace - Přehled HW a SW požadavků jednotlivých částí systému, návody instalací a seznam instalovaných souborů; |
| ▪ | Konfigurace systému - Nabízí přehled všech nutných nastavení; |
| ▪ | Bezpečnost systému - Popis mechanismu zabezpečení jednotlivých částí systému a způsob logování přístupů; |
| ▪ | Data a související procesy - Obsahuje přehled zdrojových i cílových dat, uložených procedur, popis všech hlavních procesů; |
| ▪ | Harmonogram zpracování - Obsahuje přehled a popis jobů; |
| ▪ | Údržba systému - Seznam nutných aktivit, které je nutné vykonávat pro zajištění bezproblémového běhu systému. Seznam známých problémů a postupy jejich řešení; |
| ▪ | Monitorování systému - Postupy a nastavení nutné pro monitorování činnosti systému; |
a další informace nutné pro bezproblémovou instalaci, nasazení a udržování aplikace/systému v provozu.
 | | Ukázka provozní dokumentace |
|
Technická a programová dokumentace
Programová dokumentace obsahuje přesnou a důkladnou dokumentaci programového kódu aplikace/systému:
| ▪ | z velké části je generována automaticky přímo z programového kódu; |
| ▪ | umožňuje vzájemnou zastupitelnost členů týmu i pozdější pokračování ve vývoji, úpravy a rozvoj aplikace/systému; |
| ▪ | vyžaduje (zároveň kontroluje) vývojáři správně komentovaný programový kód. |
 | | Ukázka programové dokumentace |
|
