Model annotations

 

Before generating Scope Manager documentation, you must first enter the information that will figure in the generated document for the elements in your Scope Manager project.  For this, description notes are used.

 

Description notes can be added to requirement containers, requirements, dictionaries, terms, goal containers, goals, business rules containers and business rules.

 

To add a description to an element, there are two options:

·         either you can simply enter a description in the window dedicated to the element in question (as shown in the screenshot below)

·         or you can enter a description directly in the dedicated Scope editor (this is only possible for requirements, terms, goals and business rules)

 

Entering a description for a requirement

 

Steps:

1.      In the explorer, double-click on the element for which you want to enter a description.  The dedicated edition window then appears.

2.      In the "Description" field, enter a description for the element.

3.      Click on "OK" to confirm.  If you click on "Apply", the newly entered description is confirmed and the window remains open.

 

If you choose to enter the element description directly in a dedicated Scope editor, you simply have to double-click on the associated zone in the "Definition" or "Description" column and enter the description directly.