Skip to main content

Annotation

This article explains the "Annotation" answer type in audit templates. The "Annotation" answer type is used to display text or instructions to the auditor during the audit. It is not a traditional question as it does not require the auditor to provide an answer. "Annotation" serves to convey additional information, instructions, or explanations that may be helpful to the auditor.

Annotation question type in an audit template | AuditBLOOM

Requirements. You will need:

One of the roles:

  • Administrator
  • Template Management

Workspace type:

  • Full workspace.

Step-by-Step Guide​

Adding an Annotation Question​

  1. Go to the audit template editor:

    • Log in to the system and navigate to the "Audit Templates" section.
    • Select the required template or create a new one.

  2. Add a new question:

    • Click "Add Question" in the desired section or category.
    • Select the "Annotation" question type from the list of available types.

  3. Configure the question parameters:

    • Question Text: Enter the text you wish to display to the auditor. This can include instructions, explanations, or any other information.

  4. Save changes:

    • Once the question is configured, the template will be saved automatically.

How Annotations Work During an Audit​

  • The auditor opens the question with the "Annotation" answer type.
  • They see the text you entered in the "Question Text" field.
  • No answer is required, allowing the auditor to review the information and proceed to the next question.

Notes and Tips​

Notes and Tips
  • Informative Content: Use "Annotation" to provide essential information that helps the auditor better understand the context or requirements of the audit.
  • Audit Structuring: "Annotation" can be used to separate sections of the audit or highlight key points.
  • Text Formatting: Currently, text in "Annotation" does not support formatting. Therefore, ensure the information is clear and concise.
  • No Additional Settings: The "Annotation" answer type does not include logic or mandatory settings, simplifying its use.

Frequently Asked Questions (FAQ)​

Question: Can an auditor leave a comment or response to an "Annotation"?
Answer: No, the "Annotation" answer type does not allow for responses or comments. It is purely informational text for the auditor's reference.

Question: Can I add images or files to an "Annotation"?
Answer: No, "Annotation" only supports text content. If you need to attach files or images, use the "Instruction" question type.

Question: Can logic be applied to "Annotation"?
Answer: No, the "Annotation" answer type does not support logic settings.

Question: Can an "Annotation" be mandatory to view?
Answer: No, since an "Annotation" does not require a response, it cannot be set as mandatory.

Question: When should I use "Annotation" instead of other question types?
Answer: "Annotation" is ideal for providing additional explanations, instructions, or information that does not require any action or response from the auditor.