Help Text and Descriptions
Help text and descriptions in uAuditor allow template designers to provide additional instructions and clarification for inspectors while they answer inspection questions. These elements improve consistency, reduce interpretation errors, and ensure inspections are completed correctly across all locations.
They are especially useful when inspections involve procedures, measurements, or compliance standards that require explanation 📋
What Are Help Text and Descriptions?
Each inspection question can include:
- a description
- a help text
Both appear during inspections and guide inspectors on how to answer correctly.
They help explain:
- what the question means
- how to evaluate the checkpoint
- what criteria determine pass or fail
- what evidence should be captured
- what standards must be followed
This ensures inspectors apply the same evaluation logic across branches.
Difference Between Help Text and Descriptions
Although both provide guidance, they serve slightly different purposes.
- Descriptions
- Descriptions explain the purpose of the question or provide context about what is being inspected.
- Example: Verify that refrigeration temperature remains within the approved operating range.
- Help Text
- Help text provides detailed instructions about how to answer the question.
- Example: Temperature must be between 2°C and 5°C. Attach a photo of the thermometer reading.
Descriptions explain what to check, while help text explains how to check it.
Why Use Help Text and Descriptions
Using help text and descriptions helps organizations:
- standardize inspection procedures
- reduce inspector uncertainty
- improve scoring consistency
- support new team members during inspections
- reduce training requirements
- strengthen compliance accuracy
They ensure inspections follow clearly defined operational expectations.
How to Add Help Text and Descriptions
To configure help text or descriptions:
- Open the Templates module
- Select the template you want to edit
- Navigate to the relevant Page and Section
- Select the target question
- Enter content in the Description field
- Enter content in the Help Text field
- Save the question
Both fields support bilingual configuration when templates are created in Arabic and English.
Where Help Text Appears During Inspections
During inspections:
- descriptions appear directly under the question title
- help text appears as additional guidance for inspectors
- both help clarify expectations before answering
- inspectors can review them while capturing evidence
This improves accuracy without interrupting inspection workflow.
Example Use Cases
Organizations commonly use help text and descriptions for:
- Measurement Instructions
- Explain acceptable ranges and required tools.
- Compliance Criteria
- Clarify municipality or internal standards.
- Evidence Requirements
- Describe what type of photo should be captured.
- Operational Steps
- Guide inspectors through multi-step verification tasks.
These examples ensure inspections are completed correctly the first time.
Best Practices for Writing Help Text and Descriptions
To configure effective guidance:
- keep instructions short and clear
- define pass/fail criteria when possible
- include required measurement ranges
- explain expected evidence types
- avoid unnecessary technical complexity
- update instructions when procedures change
Clear help text and descriptions improve inspection consistency and ensure all inspectors follow the same operational standards across locations.
