You're on your way to the next level! Join the Kudos program to earn points and save your progress.
Level 1: Seed
25 / 150 points
1 badge earned
Challenges come and go, but your rewards stay with you. Do more to earn more!
What goes around comes around! Share the love by gifting kudos to your peers.
Keep earning points to reach the top of the leaderboard. It resets every quarter so you always have a chance!
Join now to unlock these features and more
Oftentimes Automation rules get implemented to fix a problem but are only re-visited when something breaks or requirements change. When it is time to refactor a rule, context is very important. Even if the person revising the rule is the same as the person that created it, it may be difficult to remember all of the details surrounding its creation. Other times the person tasked with changing the rule may not have any direct knowledge of the rule.
Under the "Rule details", a user can add a description that is useful to summarize the overall purpose of the rule, but each step along the way sometimes benefits from additional context. Just like when writing code, adding comments for your future self or future editors can save time and effort later.
Today, we can add an audit log module, but that seems to be an inconvenient use of a module especially when rules can only support a limited number of them. It would be better to have a description or comments field in each of the modules just like the "Rule details" section has. This way each step can be explained in greater detail.
It would be additionally beneficial to have the comment appear in line with the modules so that they can be read without expanding a specific module.