Maximize rule reuse by documenting each rule
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