Verze:
  1. Dokumentace objektů

    Článek: AN0001622 Aktualizováno:: 09.09.2018 Zobrazeno: 484x

    Dokumentace k jakémukoli systému je vždy důležitá. Tento fakt je obecně znám, přesto se dokumentace často nepíše či neaktualizuje. Systém ObjectGears dokáže pomoci automatickým generováním technické dokumentace, které je popsáno v tomto článku. Pokud chcete k vaší aplikaci v ObjectGears uživatelům nabídnout Uživatelskou dokumentaci, využijete funkcionalitu dostupnou u modelu.

    K základním objektům je možné zadat dokumentační text, který je na automaticky zkompletován do jednoho dokumentu. Ten lze vytisknout pro seznámení novým členům týmu či pro rychlý přehled toho, kde ještě dokumentace není na dostatečné úrovni.

    Dokumentace objektů systému ObjectGears

    Na stránce modelu je tlačítko  DOKUMENTACE, které zobrazí stránku pro zadání dokumentace pro daný objekt. Dokumentace není lokalizovaná, používejte proto jazyk, který ve firmě převažuje. Na text není kladeno žádné omezení. Můžete jej různě formátovat.

    Vygenerování dokumentace pro model

    Na stránce modelu je tlačítko  ZOBRAZIT DOKUMENTACI, které vygeneruje celkovou dokumentaci pro celý model. Obsahuje informace o modelu, rolích v modelu, třídách, sloupcích, stránkách atd.

    Vygenerování dokumentace pro role

    Stejně jako lze vygenerovat dokumentaci pro model, je možné vygenerovat přehled i pro všechny role v systému. Role nejsou součástí modelů, ale stojí na stejné úrovni. Proto je tlačítko pro generování na stránce Seznam rolí.

    Vygenerovaná dokumentace obsahuje pouze role (název a kód role + dokumentační text).

  2.    ---
    Vaše hodnocení:
    Hodnotilo uživatelů: 0x
  3. Top
SearchTitle
×