Documenting terms

You document business terms to provide guidance to policy managers.

About this task

To make business terms reusable and provide guidance to policy managers, it is important to document them. The documentation you add displays in the information box next to the Content Assist box when you edit business rules.

Procedure

To document a term:

  1. In the Outline view, click the class corresponding to the term you want to document.
  2. In the Class Verbalization section of the BOM Editor, click Edit the documentation.
  3. In the Business Term Documentation dialog, enter the required description or comment.
  4. Click OK.

Results

The documentation text is shown at the bottom of the Class Verbalization section.