Uživatelské nástroje

Nástroje pro tento web


Sidebar

Obsah manuálu

prirucka_uzivatele:koncept_prirucky

Koncept příručky

Při psaní příručky byl brán ohled na to, aby ji bylo možno používat i jako referenční. Proto je strukturována do mnoha kapitol a podkapitol a pomocí rejstříku lze rychle dohledat oblast zájmu. Pokud téma souvisí s jiným, je většinou na něj v textu odkaz v následující podobě: Jméno kapitoly. V elektronické verzi příručky lze odkazy následovat.

Pokud je text důležitý a je mu nutné věnovat zvýšenou pozornost, je ohraničen v oranžovém boxu jako v následující ukázce:

Důležitý text

Text, který obsahuje užitečnou radu, je ohraničen v modrém boxu:

Užitečná rada

Příklady se zobrazují následovně:

Příklad

Poslední zvýrazněný typ informace představuje definice a odkazy na internet:

Jednotlivé kapitoly příručky kvůli logickému řazení témat neodpovídají sekcím v aplikaci. Také pojmenování nemusí korespondovat kvůli zkracování. Proto je součástí záhlaví každé kapitoly informační blok obsahující celou navigační cestu v aplikaci. Dále je v příloze zobrazena celá navigační mapa s odkazy na kapitoly, které se daným tématem zabývají.

Součástí informačního bloku je také informace o potřebném oprávnění. Pokud v aplikaci opisovanou funkci nevidíte, nemáte k ní přístupové právo; k jeho získání je nutné kontaktovat svého administrátora. Viz kapitola Role a oprávnění.

Popis formulářů je formou tabulky, kde je v prvním sloupci umístěn název prvku. Pokud je tučně s podtržením, znamená to, že je povinný pro vyplnění. V druhém sloupci je popis, jak prvek vyplnit. Poslední sloupec, pokud je to možné, uvádí příklad.

prirucka_uzivatele/koncept_prirucky.txt · Poslední úprava: 29.04.2013 16:56 autor: Internetové obchody

Nástroje pro stránku