Wiki

Clone wiki

C# RuleDocs / BestPractices

Home

#Best Practices The documentation generated from RuleDocs is most likely meant to be read by business managers. Technical jargon is not understood by everyone. Work with them on what they want to see in the documentation.

The order that child rules are added is very important. If we keep a strict ordering, then we can infer from the documentation what order the data was processed in.

If for some reason the ordering cannot be kept strict, then the containing class should have a data field added that indicates this fact.

Updated