Just like in a traditional report, it is possible to add a glossary to a BriefBuilder model. A glossary is a list of specific terms that are being explained by a short description.
The objective of adding a glossary is to make sure that all project participants understand the terminology that is being used in the model.
Terms that are part of the glossary, are highlighted in the model by means of a dotted line under the relevant term (see screenshot below). When hoovering with your mouse over the term, a tooltip will show the relevant description.
Please note: the glossary feature overlaps, to some degree, with the possibility to add object descriptions and property descriptions to your model. The important difference is that those descriptions will typically contain requirements information (e.g. “Sound level as defined JIS 0001, to be measured in unfurnished room”), while a glossary is intended as a neutral dictionary (e.g. “JIS: Japanese Industrial Standard). That is also why glossary terms do not get a requirement ID.
Creating a glossary
The glossary feature can be found as the first item in BriefBuilder’s navigation menu.
Note: If you do not have permission to edit requirements, you cannot create glossary terms either. If you do not have permission, and there are no glossary terms in the model, the menu item will not be visible to you.
To add a term, click on + Add term.
Please note:
• Glossary terms are case-sensitive.
• Glossary terms must be at least 3 characters long.
• Glossary terms must start and end with an alphanumeric character.
Also note: when you refresh the page, the glossary will automatically arrange all terms in alphabetical order.
Glossary in Word reports
When make a Word report, you will have the option to include or exclude the glossary. By default, it is included. It will is placed at the end of the report and will contain only those terms that are present in the report.
