Konvence použité v dokumentaci
Odlišení poznámek, příkladů atd.
Text nápovědy je obohacen o různé příklady, poznámky, upozornění či tipy pro vás. Pro lepší přehlednost je graficky odlišen od ostatního textu, přičemž podle situace mohou být tyto texty rozbaleny nebo sbaleny (pak mají u sebe ikonu, indikující případ, kdy je na stránce k dispozici nějaký defaultně skrytý text, který si lze kliknutím myší rozbalit a zobrazit).
Toto je příklad, který není rozbalovací, tj. tento text je viditelný vždy. Na rozdíl od následujícího příkladu, který se rozbalí až po kliknutí.
Příklad (zde klikněte)
Tento text se zobrazí po kliknutí myší na předchozí odkaz Příklad. Po opětovném kliknutí se tento text opět skryje. Použito typicky v případě často se opakujících či dlouhých textů, kdy dočasné skrytí zlepšuje přehlednost dané stránky.
Identifikace popisovaných položek
Popisované položky jsou v dokumentaci typicky identifikovány českým názvem, pod kterým se vyskytují na vstupních/výstupních formulářích jednotlivých agend.
Některé agendy jsou však založeny na definovatelných vstupních formulářích nebo jejich nástupcích variantních vstupních formulářích, které si uživatel může takřka libovolně upravovat dle vlastní potřeby. Vzhled takových formulářů u daného uživatele se pak může výrazně lišit od vzhledu dodávaného defaultně výrobcem. Proto tam, kde je to účelné, je pro lepší identifikaci popisovaných položek uveden ještě její anglický název tak, jak je definována v programu. Tento název je uveden v závorce a (italikou).
Pokud se chcete ujistit, o jakou položku se v daném formuláři jedná (nejste si z jejího pojmenování v daném formuláři jisti), pak si můžete její název zobrazit pomocí tooltipu nebo přímo v definici formuláře. Viz též Možnosti zobrazení názvu položky v def. vstupním formuláři a Možnosti zobrazení názvu položky ve var. formuláři.
Příklad zobrazení názvu položky definovatelného formuláře v tooltipu
Pokud se na takovou položku odkazujeme z jiných agend, než ze kterých pochází, pak je před názvem uvedena ještě upřesňující zkratka, aby nedošlo k záměně. Identifikace takové položky je pak unikátní a nemůže dojít k omylu ani při použití jiného českého pojmenování např. na vstupním formuláři.
Doposud jsou zavedeny následující zkratky:
- PL - personální listy, tj. zaměstnanci
- PP - pracovní poměry
- MLD - mzdové listy dílčí
- MLS - mzdové listy souhrnné
- GP - globální proměnné
- RZÚ - roční zúčtování
- PR - průměry
Objasníme na příkladu:
Popis položek, který je uveden u mzdových listů souhrnných (MLS), může vypadat např. takto:
| Název | Popis |
|---|---|
| SP základ celkem S_SocialInsBase | Počítaná položka. Celkový základ SP vypočtený ze základů SP pro jednotlivé prac. poměry daného zaměstnance (MLD:S_SocialInsBaseCorrect)......atd. |
Tj. na nějakém vstupním formuláři souhrnného mzdového listu je položka "SP základ celkem". V programu je definována pod názvem S_SocialInsBase (a pod tímto názvem ji lze i vyhledat v programu i v helpu). Popis se odkazuje na položku dílčího mzdového listu "Základ SP" (S_SocialInsBaseCorrect). Jelikož se jedná o položku jiné agendy (jiného Business objektu), je uvedena i její zkratka, aby nedošlo k záměně, tj. (MLD:S_SocialInsBaseCorrect).
Obrázky v helpu
Nápověda je doplněna řadou obrázků (typicky printscreenů) ze systému IS FLORES. Obrázky mohou být zobrazeny rovnou ve své velikosti nebo jen jako zmenšeniny, které se zobrazí v původní velikosti po kliknutí na daný obrázek.
Obrázky v nápovědě nasnímané ze systému IS FLORES jsou nasnímány z různých verzí systému běžícího na různých verzích Windows.
Jejich vzhled se tedy může drobně lišit od toho, co vidíte na obrazovce vy (podle toho, jakou verzi
Nicméně bez ohledu na to mají dostatečnou vypovídací schopnost, která vám jistě bude nápomocna v pochopení probírané problematiky.