Struktura příručky |
  
|
Struktura příručky |
|
Příručka je členěna do několika logických celků:
•Oddíl Úvod popisuje jednotlivé tematické celky příručky a přináší základní informace o příručce.
•Oddíl Uživatelské role definuje role uživatelů aplikace. Jednotlivé role odkazuje do relevantních kapitol příručky.
•Oddíl Popis aplikace popisuje uživatelské rozhraní aplikace, základní objekty, včetně ovládacích prvků.
•Oddíl Pracovní postupy je hlavní částí příručky (tzv. uživatelská část). Obsahuje podrobný popis všech pracovních postupů. Poskytuje srozumitelný popis kroků vedoucích k vyřešení všech částí problematiky, která je danou aplikací pokrývána. Popis jde do hloubky úrovně jednotlivých přehledů a formulářů s důrazem na komplexní a srozumitelné osvětlení jednotlivých procesů, tj. neklade si vždy za úkol vysvětlení všech dostupných detailů (např. „Položka Jméno uživatele obsahuje jméno uživatele“), nýbrž vysvětlení logiky procesních kroků nutných ke splnění požadovaného úkolu. Tento oddíl dokumentace je určen všem uživatelským rolím.
Oddíl obsahuje též kapitolu Základní ovládání aplikace, ve které je obsažen popis obecných pracovních postupů platných pro celou aplikaci s důrazem na pochopení logiky ovládání celého systému. Tato část dokumentace je určena k seznámení s aplikací začínajícím uživatelům.