Documenting the Vocabulary

ILOG JRules User Guide > Creating Rule Projects > Tasks > Defining a Vocabulary > Documenting the Vocabulary

Documenting the Vocabulary

To make the vocabulary reusable and provide guidance to policy managers, it is important to document it thoroughly. Vocabulary documentation is displayed in the information box next to the Content Assist box that appears when you edit business rules.

To document a term:

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

The documentation text appears at the bottom of the Class Verbalization section.

To document a phrase:

In the Outline view, click the member you want to document.
In the Member Verbalization section of the BOM Editor, to the right of the Template field, click the Edit Phrase Documentation button.
In the Phrase Documentation dialog, enter the required description or comment.
Click OK.

To view the documentation text again, click the

Edit Phrase Documentation button.

Documenting the Vocabulary

Related Concepts

Related Tasks

Related Reference

Related Samples and Tutorials