Konvence použité v dokumentaci

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í.

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.

Kromě popsaných příkladů jsou k dispozici i instruktážní videa na dané téma. Video návody, tipy a triky. V některých kapitolách je video vloženo přímo, v některých, např. v kap. Změny ve verzích, je dostupnost videa na dané téma signalizována ikonou videa .

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:

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).

Nápověda je doplněna řadou obrázků (typicky printscreenů) ze systému ABRA Gen. 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. K dispozici jsou i různá videa.

Obrázky a videa v nápovědě jsou nasnímány z různých verzí systému ABRA Gen, různých verzí Windows, s různými nastaveními vzhledu (v závislosti na době vzniku). Vizuálně se tedy mohou odlišovat od vámi používané verze produktu a aktuálního nastavení. Bez ohledu na vizuální rozdíly však stále relevantním způsobem osvětlují danou problematiku.

Např.:
- Windows XP - Motiv=Klasické nastavení/Okna a tlačítka=Klasické nastavení/Barevné schéma=Standardní nastavení
- Windows XP - Motiv=Windows XP/Okna a tlačítka=Styl Windows XP/Barevné schéma=Výchozí (modrá)
- Windows 7 - Motiv Windows 7 - základní, obdobně u vyšších verzí Windows
- ABRA vzhled modrý, ABRA vzhled červený
- ABRA vzhled od v. 21.3
- apod.

NEDÍLNOU součástí dokumentace (helpu) jsou Změny ve verzích. Funkcionalita popsaná ve změnách ve verzi je aktuálně platná k dané verzi, a to i v případě, že by nějaká jiná část helpu obsahovala popis jiný (taková část helpu nemusí být k danému datu zatím zcela aktuální). Do dalších částí helpu jsou jednotlivé změny zapracovávány postupně. Před instalací update JE NUTNÉ se se změnami ve verzi PEČLIVĚ seznámit. Viz kap. Změny ve verzích a příslušné podkapitoly.

V rámci lokalizací systému je lokalizována i dokumentace.

Jedná se nejen o jazykové překlady, ale i o odlišný obsah a rozsah nápovědy s ohledem na danou lokalizaci (tj. např. odlišnou funkčnost a požadavky trhu).

U CZ/SK lokalizace on-line nápověda do anglického a německého jazyka překládána není. V anglickém jazyce jsou k dispozici pouze některé vybrané složky dokumentace. Např. Struktury a definice systému (GenDoc.chm). Viz též Aktuálně dostupné lokalizace systému ABRA Gen a jazykové mutace. V německém jazyce je k dispozici nápověda jen pro CH lokalizaci.