Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleAutomated documentation of projects and applications

Do you need to document related objects, e.g. a full application or objects of a change request? Then we recommend the usage of our so-called Scenarios, with which associated objects and their information can be bundled and documented:

  • First, create a new Scenario and give it a name and description.

  • The Scenario can be structured according to your needs with Structure Items. First, insert rich text elements to set the rough chapter structure.
  • Define so-called assignment rules at the object-specific chapters, which can refer to InfoAreas, namespaces, layer, or object types. Then integrate your objects into the Scenario. During object assignment, the system now checks whether an object meets the conditions of an assignment rule and then automatically assigns it to the respective structure item. The scenario assignment can also take place outside of the scenario (e.g. out of the Data Flow).
  • Fill the scenario with life by annotating the chapters and the objects with your texts - in the Comment Mode. If your documentation is of an application, you can add additional information about the data model or define the responsibilities.
  • Export the whole Scenario manually or automated in a regular cycle with the AutomationTool.

...