Requiring Descriptions
The Require Description setting in uAuditor ensures that users must provide a written explanation before marking an action as completed. This helps organizations document corrective steps clearly and maintain a reliable record of how issues were resolved.
Requiring descriptions improves traceability and supports stronger corrective action verification.
What Does Requiring Descriptions Mean?
When description requirements are enabled:
- users must enter a description before completing an action
- the Completed status is not available until a description is provided
- corrective steps are documented in the action record
- supervisors can review resolution details easily
Descriptions become part of the permanent action history.
Why Require Descriptions for Actions
Requiring descriptions helps organizations:
- document corrective procedures clearly
- improve accountability across teams
- support audit and compliance requirements
- explain how issues were resolved
- reduce incomplete corrective reporting
- strengthen operational transparency
Written documentation complements visual evidence when verifying issue resolution.
When to Use Description Requirements
Description requirements are especially useful for actions related to:
- compliance corrections
- operational deviations
- safety procedures
- maintenance interventions
- process adjustments
- supervisor follow-up instructions
These scenarios benefit from clear written explanations.
How Description Requirements Work
When enabled:
- an action is assigned to a user
- the user performs the corrective task
- the user enters a description explaining the resolution
- the system allows the action to be marked as Completed
If a description is missing:
- the action cannot be completed
- the system prompts the user to provide details
This ensures corrective steps are recorded before closure.
How to Enable Description Requirements
To require descriptions before completing actions:
- Open the Actions module
- Go to Action Configuration
- Navigate to Requirements Configuration
- Enable Description Required
- Save the configuration
The setting applies to newly created actions.
What Should Be Included in Action Descriptions
Effective action descriptions typically include:
- the issue identified
- the corrective step taken
- the responsible person (if applicable)
- the resolution method used
- any follow-up actions required
Clear descriptions improve understanding for reviewers and auditors.
Impact on Corrective Workflows
When description requirements are enabled:
- corrective steps are documented consistently
- supervisors can verify resolution accuracy
- action history becomes more informative
- audit readiness improves
- reporting quality increases
This strengthens the reliability of corrective action tracking.
Best Practices for Requiring Descriptions
To configure description requirements effectively:
- require descriptions for compliance-related actions
- use descriptions alongside media requirements when possible
- avoid unnecessary requirements for minor corrective tasks
- encourage clear and concise explanations
- review descriptions regularly during supervision
Requiring descriptions ensures corrective actions are clearly documented and supports consistent operational follow-up across locations.