Verzovaná dokumentace

Verzovaná dokumentace umožňuje tvorbu a správu dokumentace produktů vydávaných ve verzích a po úpravě i jakékoli jiné dokumentace. Tato aplikace ObjectGears je zajímavá i z licenčního pohledu. Typicky v ní vystačíme s malým počtem uživatelů, kteří musí být autentizování. Verzovaná dokumentace je určena pro sdílení s externími (neautentizovanými) uživateli ať už z organizace nebo z internetu. Řešení je tedy možné reálně provozovat ve free verzi ObjectGears a to i v případě velkých společností.

Verzovaná dokumentace umožňuje tvorbu a správu dokumentace

efektivní systém, který vám umožní určit, jakých verzí se článek týká

Představte si, že vyvíjíte aplikaci, kterou používají vaši zákazníci. Aktuálně máte u zákazníků aplikaci ve verzi 1.0, 1.1 a 1.2. Aby všichni zákazníci mohli plnohodnotně využívat váši aplikaci, pak musí mít k dispozici dokumentaci právě pro verzi, kterou mají. Nestačí vám tedy udržovat dokumentaci jen pro poslední verzi, ale i pro všechny předchozí. Protože neustále rozšiřujete dokumentaci o články týkající se i předchozích verzí, potřebujete efektivní systém, který vám umožní určit, jakých verzí se článek týká. Právě pro tento případ slouží modul Verzovaná dokumentace. Její reálné nasazení si můžete prohlédnout na adrese https://doc.objectgears.cz/vcd?lang=cs-CZ, kde jsme ji použili pro dokumentování systému ObjectGears.

Verzovaná dokumentace umožňuje:

  • tvorbu článků pomocí HTML editoru
  • hierarchie článků (podřízené a nadřízené články)
  • obsah ve formě textů, tabulek, obrázků, příloh souborů či videí, odkazů na jiné články
  • vyhledávání článků čtenáři
  • hodnocení článků uživateli
  • správu verzí článků a jazykové varianty článků (článek zobrazuje svůj obsah dle zvolené verze a jazykové preference uživatele)
  • řazení výsledků hledání dle relevance
  • podpora efektivní práce tvůrců obsahu (přehledy článků, které potřebují pozornost, různé možnosti propojování článků odkazy...)
  • široké možnosti konfigurace a přizpůsobení potřebám konkrétnímu zákazníkovi (včetně vzhledu)

Podívejte se na krátké představení tohoto řešení.

Další informace můžete nalézt v článku o Verzované dokumentaci.