Creating guidance for developers

Updated on November 18, 2021

Create internal documentation to provide guidance to the developers who implement or extend your application.

Use the following techniques to create internal documentation:

Adding usage information to a rule

Add usage information to a rule to help developers decide whether they can reuse the rule in their features or applications.

As a best practice, provide usage information when you create a rule.

Open a rule by searching for it or by using the Application Explorer.
Click the History tab.
In the Documentation section, enter text in the Description field that describes the purpose of your rule.
In the Usage field, enter text that helps developers understand how to use this rule.
For example, you can describe the expected inputs and outputs.
Click Save.

Describe the recent changes to a rule in the rule history to help developers trace your implementation and compare versions more quickly.

Open a rule by searching for it or by using the Application Explorer.
On the History tab, click View full history.
Click History For All Versions.
In the Add Memo field, enter text that describes the differences between this version of the rule and the prior version.
Click Add Memo.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Visit the Support Center