Článek: AN0002338Aktualizováno:: 20.12.2018
K aplikacím, které vytváříme bychom měli zpracovat dokumentaci. Technickou dokumentaci nám ObjectGears umožňuje automaticky vygenerovat - obsahuje výčet datových entit a další objektů modelu spolu s popisem, který jsme u jednotlivých objektů uvedli.
Další typy dokumentace již zpravidla vyžadují promyšlený popis, který umožní pochopit vytvořenou aplikaci a její funkcionalitu lidem, kteří s ní mají pracovat. Jedná se celkový nástin systému, jeho vazby na okolí (rozhraní/interface), logiku přístupových oprávnění, podporu systému (kontakty na administrátory a vlastníky systému) atd. Konkrétním příkladem je i uživatelská dokumentace, která má uživatelům zodpovědět otázky, které mohou u jednotlivých obrazovek vyvstat, i poskytnout celkový přehled o možnostech, které jim aplikace poskytuje.
Uživatelům můžeme usnadnit orientaci i pomocí popisů jednotlivých polí, tooltipů, placeholderů a hlášení. Tyto možnosti, které ObjectGears nabízí, je vhodné použít. Komplexní popis funkcionality však budeme chtít provést formou uceleného dokumentu (např. v MS Word nebo PDF) nebo struktury webových stránek. Oba tyto typy dokumentace je možné uvést v ObjectGears modelu a uživatelům se zobrazí po najetí na ikonu otazníku v pravém horním rohu obrazovky.
V detailu modelu (naší aplikace) zadáváme soubory či url odkazy na záložce Uživatelská dokumentace:
Soubor s dokumentací musíme vytvořit, nahrát a pro novou verzi aplikace ho aktualizovat a znovu nahrát. Sofistikovanějším přístupem je použití webových stránek, které naši aplikaci popisují z různých úhlů pohledu a jsou vzájemně propojeny odkazy.
Příklad: Verzovaná dokumentace ObjectGears
ObjectGears nabízí model verzované dokumentace, ve kterém lze snadno vytvořit dokumentaci jakéhokoli systému nebo produktu. Tato dokumentace podporuje verzování a různé jazykové verze článků. Na tuto dokumentaci se pak lze z daného systému odkazovat a zajistit, že konkrétnímu uživateli bude zobrazena daná stránka v odpovídajícím jazyku a verzi. Níže si popíšeme, jak efektivně propojit aplikace vytvořené v ObjectGears s jejich dokumentací vytvořenou v modelu Verzované dokumentace.
Ve Verzované dokumentaci si vytvoříme strukturu článků týkající se našich jednotlivých aplikací. Každá aplikace tak může mít strom článků popisující její architekturu, koncept přístupových oprávnění atd. Pro jednotlivé články můžeme vytvořit jazykové varianty a také varianty zobrazované podle zvolené verze aplikace. Jeden nebo více z článků pak formou URL odkazů přidáme do Uživatelské dokumentace v ObjectGears instanci - viz výše. Při odkazování na článek Verzované dokumentace máme možnost předat parametr jazyka a verze.
Tato dva parametry může do URL předat následujícím způsobem:
https://doc.objectgears.cz/vcd/#Language#/an/AN0001803/v/#Version#
Poté, co uživatel klikne na odkaz na dokumentaci pod ikonou otazníku v pravém horním rohu obrazovky ObjectGears, dojde k zavolání Verzované dokumentace a ta mu zobrazí daný článek v jeho jazyce a verzi. Pokud by daný článek nebyl dostupný v jazyku zvoleném uživatelem v ObjectGears, Verzovaná dokumentace zobrazí článek ve výchozím jazyku a vypíše o tom uživateli hlášení.
