Document template

Overview

A document template describes how to obtain a document from a model. It entirely conditions the nature of the produced document.

The document templates currently supplied are:

· The analysis document template, which is used to generate analysis documents

· The design document template, which is used to generate design documents

Document items

A document template also determines the documentation root. This is usually a package.

A document template is subdivided into "document items". These provide a special description for a given type of element. A document item describes each element or a set associated with a document item.

For example, the analysis document template for a package (document package) is subdivided into "document items" which concern all the important types of elements, notably classes. If you wish to obtain the part of documentation which is relative to a class, you must designate in the analysis document template the document item relative to the class.

Message files

All messages generated by a document template (chapter title, list header, …) can be defined in an external file. The document work product must then define which file should be used.