Producing Scope Manager documentation

Introduction

Objecteering Scope Manager provides you with the possibility of generating documentation for your Scope Manager project in either Word or HTML format.

The documentation generated is based on a document template you select during creation of the associated document work product (for more information on the structure of documentation generated using the different dedicated document templates, please see "Structure of generated documentation").

If you have entered descriptions for your Scope elements (requirement containers, requirements, dictionaries, terms, goal containers, goals, business rule containers, business rules), these descriptions appear in the generated document (for further information, please see "Model annotations").

Generating Scope Manager documentation

To generate documentation for a requirement container, a goal container or a business rule container, the Scope document template is used.

To run documentation generation, simply carry out the steps shown in the screenshot below.

Generating Scope Manager documentation

Steps:

1. In the tab of the explorer, right-click on the element for which you wish to generate Scope Manager documentation (a requirement container, a goal container or a business rule container). The context menu then appears.

2. In your context menu, run the "Scope Manager/Generate documentation" command. The "Document" window then appears.

3. In the "Document" window, enter the necessary information (the name, title and subtitle of your document, the name of the author, the version number, the date, the desired format, the location where the file will be saved, the message file and the document template to be used). Remember to choose the "Scope" document template, as this is the template dedicated to generating documentation for requirement containers, goal containers or business rule containers. Click on "OK" to confirm.

4. Click on "OK" to launch generation of the documentation. When generation is complete, the newly generated document is automatically launched in the editor specified during MDAC configuration.

Note: Before generating Scope Manager documentation, you must first set certain parameters, such as the documentation generation root directory and the editors you are going to use. For more information, please see "Overview of Objecteering Scope Manager parameterization".

Visualizing Scope Manager documentation

To visualize Scope Manager documentation, you have two options:

· either right-click on the element on which the documentation has been generated to open the context menu, and then run the "Scope Manager/Visualize documentation" command

· or right-click on the associated document work product to open the context menu, and then run the "Scope Manager/Visualize documentation" command

Generating dictionary documentation

To generate documentation for a dictionary, the Dictionary document template is used.

The procedure for generating dictionary documentation is identical to that used to generate Scope Manager documentation, except that the "Dictionary" document template must be selected in the "Document template" field.

Visualizing dictionary documentation

To visualize dictionary documentation, you have two options:

· either right-click on the dictionary on which the documentation has been generated to open the context menu, and then run the "Scope Manager/Visualize documentation" command

· or right-click on the associated document work to open the context menu, and then run the "Scope Manager/Visualize documentation" command

The "Edit and reverse documentation" command

The "Edit and reverse documentation" command, available on document work products, is used to launch Word on the document represented by the document work product. Once Word has been launched, a special set of icons appears, and you can work on your Scope Manager project in Word before generating an XML file and exporting it into Objecteering UML.

For more information on working on a Scope Manager project in Word, please see "Introduction to using Word with Objecteering Scope Manager".