Konvencie použité v dokumentácii

Text nápovedy je obohatený o rôzne príklady, poznámky, upozornenia či tipy pre vás. Pre lepšiu prehľadnosť je graficky odlíšený od ostatného textu, pričom podľa situácie môžu byť tieto texty rozbalené alebo zbalené (potom majú u seba ikonu, indikujúcu prípad, kedy je na stránke k dispozícii nejaký defaultne skrytý text, ktorý je možné si kliknutím myšou rozbaliť a zobraziť).

Toto je príklad, ktorý nie je rozbaľovací, tzn. tento text je viditeľný vždy. Na rozdiel od nasledujúceho príkladu, ktorý sa rozbalí až po kliknutí.

Tento text sa zobrazí po kliknutí myšou na predchádzajúci odkaz Príklad. Po opätovnom kliknutí sa tento odkaz znova skryje. Použité typicky v prípade často sa opakujúcich či dlhých textov, kedy dočasné skrytie zlepšuje prehľadnosť danej stránky.

Okrem popísaných príkladov sú k dispozícii i inštruktážne videá na danú tému. Video návody, tipy a triky. V niektorých kapitolách je video vložené priamo, v niektorých, napr. v kap. Zmeny vo verziách, je dostupnosť videa na danú tému signalizovaná ikonou videa .

Popisované položky sú v dokumentácii typicky identifikované slovenským názvom, pod ktorým sa vyskytujú na vstupných/výstupných formulároch jednotlivých agend.

Niektoré agendy sú však založené na definovateľných vstupných formulároch alebo ich nástupcoch variantných vstupných formulároch, ktoré si užívateľ môže takpovediac ľubovoľne upravovať podľa vlastnej potreby. Vzhľad takýchto formulárov v prípade daného užívateľa sa potom môže výrazne líšiť od vzhľadu dodávaného defaultne výrobcom. Preto tam, kde je to účelné, je na lepšiu identifikáciu popisovaných položiek uvedený ešte ich anglický názov tak, ako sú definované v programe. Tento názov je uvedený v zátvorke a (kurzívou).

Ak sa chcete uistiť, o akú položku v danom formulári ide (nie ste si z jej pomenovania v danom formulári istí), tak si môžete jej názov zobraziť pomocou tooltipu alebo priamo v definícii formulára. Viď tiež Možnosti zobrazenia názvu položky v def. vstupnom formulári a Možnosti zobrazenia názvu položky vo var. formulári.

Príklad zobrazenia názvu položky definovateľného formulára v tooltipe

Pokiaľ sa na takú položku odkazujeme z iných agend, ako z ktorých pochádza, potom je pred názvom uvedená ešte upresňujúca skratka, aby nedošlo k zámene. Identifikácia takej položky je potom unikátna a nemôže dôjsť k omylu ani pri použití iného slovenského pomenovania napr. na vstupnom formulári.

Doposiaľ sú zavedené nasledujúce skratky:

Objasníme na príklade:

Popis položiek, ktorý je uvedený pri mzdových listoch súhrnných (MLS), môže vyzerať napr. takto:

Názov Popis
SP základ celkom
S_SocialInsBase		 Počítaná položka. Celkový základ SP vypočítaný zo základov SP pre jednotlivé prac. pomery daného zamestnanca (MLC:S_SocialInsBaseCorrect)......atď.

Tzn. na nejakom vstupnom formulári súhrnného mzdového listu je položka "SP základ celkom". V programe je definovaná pod názvom S_SocialInsBase (a pod týmto názvom ju možno aj vyhľadať v programe aj v helpe). Popis sa odkazuje na položku čiastkového mzdového listu "Základ SP" (S_SocialInsBaseCorrect). Keďže ide o položku inej agendy (iného Business objektu), je uvedená aj jej skratka, aby nedošlo k zámene, tzn. (MLC:S_SocialInsBaseCorrect).

Nápoveda je doplnená množstvom obrázkov (typicky printscreenov) zo systému ABRA Gen. Obrázky môžu byť zobrazené priamo vo svojej veľkosti alebo len ako zmenšeniny, ktoré sa zobrazia v pôvodnej veľkosti po kliknutí na daný obrázok. K dispozícii sú i rôzne videá.

Obrázky a videá v nápovede sú nasnímané z rôznych verzií systému ABRA Gen, rôznych verzií Windows, s rôznymi nastaveniami vzhľadu (v závislosti na dobe vzniku). Vizuálne sa teda môžu odlišovať od vami používanej verzie produktu a aktuálneho nastavenia. Bez ohľadu na vizuálne rozdiely však stále relevantným spôsobom osvetľujú danú problematiku.

Napr.:
- Windows XP - Motív=Klasické nastavenie/Okná a tlačidlá=Klasické nastavenie/Farebná schéma=Štandardné nastavenie
- Windows XP - Motív=Windows XP/Okná a tlačidlá=Štýl Windows XP/Farebná schéma=Východisková (modrá)
- Windows 7 - Motív Windows 7 - základný, podobne pri vyšších verziách Windows
- ABRA vzhľad modrý, ABRA vzhľad červený
- ABRA vzhľad od v. 21.3
- a pod.

NEODDELITEĽNOU súčasťou dokumentácie (helpu) sú Zmeny vo verziách. Funkcionalita popísaná v zmenách vo verzii je aktuálne platná k danej verzii, a to i v prípade, že by nejaká iná časť helpu obsahovala popis iný (taká čas&ť helpu nemusí byť k danému dátumu zatiaľ úplne aktuálna). Do ďalších častí helpu sú jednotlivé zmeny zapracovávané postupne. Pred inštaláciou update JE NUTNÉ sa so zmenami vo verzii POZORNE zoznámiť. Viď kap. Zmeny vo verziách a príslušné podkapitoly.

V rámci lokalizácií systému je lokalizovaná i dokumentácia.

Ide nielen o jazykové preklady, ale i o odlišný obsah a rozsah nápovedy s ohľadom na danú lokalizáciu (tzn. napr. odlišnú funkčnosť a požiadavky trhu).

Nápoveda je prekladaná priebežne, hoci sa vplyvom časového oneskorenia prekladov môže stať, že aktualizácia niektorých kapitol helpu pre SK/CH lokalizáciu má istý časový rozstup, prípadne sa niektoré kapitoly môžu vyskytovať dočasne v českom jazyku (úplne alebo čiastočne). Ospravedlňte, prosím, chýbajúci preklad, bude dodaný v najbližšom možnom termíne.

V prípade CZ/SK lokalizácie on-line nápoveda do anglického a nemeckého jazyka prekladaná nie je. V anglickom jazyku sú k dispozícii len niektoré vybrané zložky dokumentácie. Napr. Štruktúry a definície systému (GenDoc.chm). Viď tiež Aktuálne dostupné lokalizácie systému ABRA Gen a jazykové mutácie. V nemeckom jazyku je k dispozícii nápoveda len pre CH lokalizáciu.