Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Maximize rule reuse by documenting each rule

Updated on March 28, 2008

 This presentation is part of the Reusability and Specialization e-Learning Course.


Well documented rules allow rules to be more easily reused as they provide other developers a clear description of how and why to use a rule.  On the other hand, poorly documented rules may lead to a lack of reuse, as other developers may not understand what your rule does or how to properly use it, and may decide it’s just easier to write a rule on their own.

Some simple tips to documenting your rules for reuse include:

  • Create a short description that allows the developer to clearly understand the functionality of the rule
  • Document the usage on the history tab, including any assumptions regarding parameters on the parameters page, page names, classes, etc.
  • Always document your parameters and give examples of valid values

Have a question? Get answers now.

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

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us