Missing flow element descriptions
Why is this an issue?
A description on the flow itself says what the automation does as a whole, not why any individual step exists. Elements are where a flow's logic lives, and the canvas only shows what each one does, never why. Descriptions help developers and administrators:
Understand why a decision branches the way it does, or why a filter is set the way it is
Change a step safely, without re-deriving its intent from the rest of the canvas
Examples
Example of incorrect metadata:
<decisions>
<name>Has_Contacts</name>
<label>Has Contacts</label>
</decisions>
Example of correct metadata:
<decisions>
<name>Has_Contacts</name>
<description>Only continues when the account has at least one contact, so the update loop has something to work on.</description>
<label>Has Contacts</label>
</decisions>
How can I fix violations?
Add a description to the element explaining why the step exists, rather than restating its name:
Open the flow in Flow Builder
Open the element's configuration from the canvas
Fill in the Description field
Save the flow
This rule only reports elements in active flow versions, and only those that have a name.
When should I disable this rule?
You may dismiss specific violations for simple, self-explanatory elements where the name clearly indicates the purpose.
Resources