Creating notes and tagged values

Creating notes and tagged values in the "Auxiliary properties" tab of the auxiliary window

Create a project named "UML Training". Inside this project, create the "Training system" package.

We are now going to add the {analysis} tagged value to the "Training system" package, as shown in Figure 3.

Figure 3. "TrainingSystem" is the document package

Steps:

1. Select the "TrainingSystem" package in the explorer.

2. Select the "Auxiliary properties" tab in the auxiliary window, and click on the "Associate a tagged value" icon. The "Tagged value creation" window then appears.

3. Select the {analysis} tagged value.

4. Click on "Create" to confirm.

Continue by creating the "overview", "purpose", "reference" and "dictionary" notes in the same way (by clicking on the "Create a note" icon in the "Auxiliary properties" tab in the auxiliary window).

Creating notes in the "Documentation" tab of the auxiliary window

Certain notes can be created through the "Documentation" tab of the auxiliary window, as shown in Figure 4.

Figure 4. Creating notes in the "Documentation" tab of the auxiliary window

Steps:

1. Select the "Training system" package in the explorer.

2. Select the "Documentation" tab in the auxiliary window.

3. Enter the contents of the summary note you wish to create in the "Summary" field.

4. Enter the contents of the description note you wish to create in the "Description" field.

You can check the results of these entries by clicking on the "Auxiliary properties" tab of the auxiliary window. As you will see, a description note and a summary note are now present on the "Training system" package.

Documentation notes

All model elements (class, attribute, association, diagram, …) have at least one note type to describe them, with the two most common types of note being "summary" and "description".

The ... note type	is used to ...
overview	give a general presentation of the document and the information system it describes.
purpose	explain the document’s objective, what is represented and what is computerized.
reference	give the list of document references used by the present document.
dictionary	give the glossary of terms used in the model.
summary	give a short description (in one line) of the current package.
description	describe in detail the current package.