Help Documents
Help document questions in uAuditor allow administrators to attach supporting files inside inspection templates so inspectors can view them while completing inspections. These documents provide guidance, procedures, or technical references directly within the inspection workflow.
Help documents improve inspection accuracy by giving inspectors access to the correct information at the right time.
What Are Help Document Questions?
A help document question allows you to attach a reference file that appears inside the inspection interface during execution.
These attachments may include:
- equipment manuals
- safety procedures
- inspection standards
- compliance policies
- maintenance instructions
- training references
Unlike document upload questions, help documents are provided to inspectors, not uploaded by them.
Why Use Help Documents
Help documents help organizations:
- standardize inspection procedures across teams
- support new inspectors during inspections
- reduce interpretation errors
- ensure correct measurement methods are followed
- provide compliance reference material
- improve inspection consistency across locations
They act as embedded operational references inside inspections.
When to Use Help Documents
Help document questions are especially useful when inspections involve:
- equipment operating instructions
- cleaning procedures
- safety compliance guidelines
- municipality inspection standards
- calibration steps
- internal SOP references
They ensure inspectors follow approved procedures during inspections.
How to Add a Help Document Question
To add a help document question to a template:
- Open the Templates module
- Select the required template
- Open the target Page
- Select the appropriate Section
- Click Add Question
- Select Help Document as the question type
- Upload the reference file
- Save the question
The document becomes available to inspectors during inspections.
Example Use Cases for Help Documents
Organizations commonly use help documents for:
- Equipment Inspection Guidance
- Example: Attach a refrigeration unit manual before temperature verification questions.
- Cleaning Procedures
- Example: Attach sanitation workflow instructions for inspectors to follow.
- Safety Compliance Standards
- Example: Provide PPE requirements checklist before safety verification steps.
- Maintenance Instructions
- Example: Attach maintenance procedure documentation for technician reference.
These references ensure inspections are completed correctly.
How Help Documents Appear During Inspections
During inspections, help documents:
- appear inside the inspection interface
- can be opened by inspectors when needed
- provide step-by-step operational guidance
- support accurate response selection
- reduce uncertainty during checklist execution
They act as embedded reference material throughout the inspection process.
Best Practices for Using Help Documents
To configure help documents effectively:
- attach only relevant supporting files
- use clear document titles
- keep documents updated with current procedures
- place them before related inspection questions
- avoid attaching large or unnecessary files
Help document questions improve inspection reliability by ensuring inspectors always have access to the correct procedures and reference materials while performing operational checks.
