Missing descriptions in flows
Why is this an issue?
Flows without descriptions are harder to understand and maintain. Descriptions help administrators and developers:
Understand the flow's purpose at a glance
Identify the correct flow in lists
Troubleshoot issues more effectively
Examples
Example of incorrect flow (no description):
<Flow>
<label>Update Case Status</label>
<!-- No description element -->
</Flow>
Example of incorrect flow (empty description):
<Flow>
<label>Update Case Status</label>
<description></description>
</Flow>
Example of correct flow (with description):
<Flow>
<label>Update Case Status</label>
<description>Automatically updates case status to 'In Progress' when
an agent first responds. Triggered on Case update when
Response_Sent__c changes to true.</description>
</Flow>
Note: Descriptions on individual flow elements (such as action steps or screens) do not satisfy this rule. The <description> must be a direct child of the <Flow> element.
How can I fix violations?
Add a description to your flow:
Open the flow in Flow Builder
Click the flow name to edit properties
Add a meaningful description explaining:
What the flow does
When it runs (for triggered flows)
Key business logic it implements
When should I disable this rule?
You may dismiss specific violations for simple, self-explanatory flows where the name clearly indicates the purpose.
Resources
