Nová dokumentace Cross

Dokumentace produktu CROSS dostává novou podobu odpovídající moderním trendům. Integrace do jednoho komplexního řešení využívá různé formy aktuálně dostupné dokumentace.

Uživatelská dokumentace je postupně převáděna z knižního formátu vhodného pro tisk na papír do prolinkované html struktury s odkazy na tutoriály (upravené test cases), datový model, funkční model a případy použití (use cases).

Samotnou uživatelskou dokumentaci bude stále možné zobrazit na jedné stránce a „vytisknout“ do PDF, pokud bude potřebná offline verze v jednom dokumentu. Aktuálně máme schválený Proof of concept a pokračujeme v konverzi. Nadpisy a podnadpisy fungují jako kotvy s pevným odkazem. Je tak možné na ně odkázat ze samotné aplikace, jakmile do ní bude doplněna podpora pro odskoky do dokumentace.

Nová dokumentace je uložena v Gitu ve formě zdrojového kódu, který lze kompilovat pomocí nástroje Antora. Až bude projekt dokončen, je v plánu partnerům zpřístupnit tento repositář, aby si mohli udělat klon a následně upravit dokumentaci dle svých potřeb.

Současně díky Gitu bude jednoduché sledovat změny mezi jednotlivými verzemi dokumentace.

You may also like these

No Related Post