Task Topics

Task topics aim to provide clear steps on how to achieve a specific business goal. They should also explain why and in which context the task is to be performed. Well-documented procedures are important part of any documentation set. Typical examples include steps on how to create or maintain data, configure a system or device, or complete any type a procedure.

User Intent

"I want to complete a task and understand how and why I need to do this."

Common Tags

• <task>: Root element.
• <title>: Task to be performed (for example, "Reset Your Password").
• <shortdesc>: Precise summary of the goal and when to perform the task.
• <taskbody>: Container for steps and results.
• <steps> and <step>: Ordered procedural instructions.
• <result>: Outcome of the task.
• <prereq>: Any prerequisites to be met before performing the task.
• <context>: Additional background information about performing the task.
• <postreq>: Recommended follow-up actions.

Best Practices for Writing

• Describe one task in the topic (consider splitting if it gets too long)
• List any prerequisites.
• Use imperative voice (for example, "Save your data.").
• Include expected results for complex steps.
• Provide specific UI element names as necessary (using generic formulations can be more efficient if the UI changes frequently).
• 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>Reset your account password using email verification if you've forgotten your password or suspect that your account has been hacked.</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>