Task Topics

Task topics provide clear, step-by-step instructions for completing specific procedures and reducing user errors.

Use

Task topics provide clear, step-by-step instructions for completing a procedure. They are best used when guiding users through a specific action, such as installing software, configuring settings, or submitting forms. Tasks reduce user errors by presenting actions in a consistent, predictable way, making them ideal for call centers, onboarding flows, and support documentation.

User Intent

"I need to get something done right now."

Common Tags

  • <task>: Root element.
  • <title>: Action name (e.g., "Reset Your Password").
  • <shortdesc>: Quick summary.
  • <taskbody>: Container for steps and results.
  • <steps> and <step>: Ordered procedural instructions.
  • <result>: Outcome of the task.
  • <prereq>: Optional requirements before starting.
  • <context>: When and why to perform this task.
  • <postreq>: Recommended follow-up actions.

Step Structure Best Practices

  • One action per step.
  • Use imperative voice (e.g., "Click Save").
  • Include expected results for complex steps.
  • Provide specific UI element names and locations.
  • Use conditional steps for different scenarios.
  • Test task topics with actual users to identify gaps and ensure clarity.

Sample XML Code


<task id="resetpassword">
  <title>Reset Your Password</title>
  <shortdesc>This procedure resets your account password using email verification.</shortdesc>
  <taskbody>
    <steps>
      <step>Go to the login page and click "Forgot Password".</step>
      <step>Enter your registered email address.</step>
      <step>Follow the link sent to your email to set a new password.</step>
    </steps>
    <result>Your password is now updated and you can log in.</result>
  </taskbody>
</task>