Before you begin…

Before starting

Before you generate any documentation, you must have a structured model in which the entry points containing the elements that are to be appear in the documentation are determined. 

Different types of notes describing different aspects of the element are proposed for each element. Once your model has been annotated using these notes, you can then proceed with documentation generation.

Before beginning this quick tour, the "DocumentPublisher" MDA component must be deployed in your project by running the "Tools/Deploy an MDAC" command and selecting the "DocumentPublisher" MDAC.

For more information on deploying MDA components, see "Working with MDACs".

Documentation roots

Documentation generation always starts from one or several model elements, in order to generate all the elements it (they) structure(s).

Most of the time, the element concerned is a package, but it can also be a class, an actor, a use case or any other type of element according to the document template being used.