Model structure

Overview

Documentation generation is entirely guided by the model’s structure in terms of packages and classes. The numbering of the chapters, document layout and document composition are managed by the model's structure and the document template.

Documentation root

Documentation generation always starts from an element in the model, to generate all the elements structured by this element. Most of the time the element concerned is a package, but it can also be a class, an actor, a use case or another type of element.

Document package

A document package is a package which contains:

· the documentation root of a document

· the numbering of the chapters, the layout and the composition of this document

· general textual descriptions for the whole document ("Introduction", "Reference documents", …)