Structure of generated documentation

Introduction

Two dedicated document templates, "Dictionary" and "Scope", are provided for use respectively in the generation of dictionary or Scope Manager documentation. To base your documentation on one or other of these document templates, simply select it in the "Document template" field when creating the associated document work product.

When documentation is generated in HTML format, a model explorer and an index are automatically generated. The model explorer displays the model's hierarchy in hypertext link form, whilst the index displays a list of the documented requirement containers or dictionaries in alphabetical order, also in hypertext link form. You can jump to any element which interests him within the generated document, simply by clicking on the corresponding hypertext link.

To switch from the model explorer to the index, you should simply click on the corresponding "Index" or "Model" hypertext links on the top left of your document.

Note: For information on generating requirements or dictionary documentation, please see "Producing Scope Manager documentation".

Structure of "Dictionary" documentation

When documentation generation is based on the "Dictionary" document template, the structure of the generated documentation is as follows:

· The "Overview". This section provides a summary of the different dictionaries presented in the documentation.

· For each individual dictionary, the following information is presented:

o Its owner (the dictionary which is above it hierarchically)

o Its description

o Traced elements

o The terms contained in the dictionary, together with their descriptions

Structure of "Scope" documentation

When documentation generation is based on the "Scope" document template, the structure of the generated documentation is as follows:

· The "Overview". The section provides a summary of the different requirement containers, goal containers or business rules presented in the documentation.

· For each individual requirement container, goal container or business rule, the following information is presented:

o Its owner

o Its description

o The list of requirements, goals or business rules it contains, with a hypertext link to each

o For each requirement, goal or business rule, its owner and its description are presented

· Traced elements