Glossary · Information types
DITA task
Also known as: task topic, procedure, strict task, general task
In DITA, a task is a topic type for procedural information: it describes how to accomplish a goal, usually as a sequence of steps. Its body element <taskbody> contains sections such as prerequisites, context, steps, result and follow-up, and each step contains exactly one command.
- DITA
- Information typing
In one sentence
A DITA task is the topic type for procedures: prerequisites, steps with one command each, results and follow-up, in a fixed structure.
Example
The task “Replacing the air filter” with a prerequisite (disconnect the power), three steps and a step result (“The cover clicks into place”).
Explained in context
Context cards connect this term with others to answer one question. Also in British English and German.
- Cognitive load and split attention: why figures, labels and text belong togetherTransitional topicWhat does cognitive load theory say about combining figures and text in instructions, and what follows for technical documentation?UKDeutsch
- Mental models and concept information: why readers need to know how it works before they actTransitional topicHow does research on mental models support placing concept information before task information in technical documentation?UKDeutsch
- Cognitive psychology in technical communication: theory, application and the bridges between themTransitional topicWhat is the difference between cognitive psychology as theory and its application in documentation, and how do the two fit together?UKDeutsch
- Working memory and procedure steps: why "seven plus or minus two" is the wrong ruleTransitional topicDoes working memory research justify a fixed maximum number of steps in a procedure, such as seven plus or minus two?UKDeutsch
- Task analysis: one task, three lensesIs task analysis one method, or are technical, collaborative and cognitive task analysis different things?UKDeutsch
- Topic-based vs. task-based documentationIs topic-based documentation the same as task-based documentation?UKDeutsch
- Minimalism and structured authoringHow do minimalism and structured authoring work together?UKDeutsch
- Six technical documentation models comparedHow do topic-based, task-based, EPPO, semantic, minimalist and structured documentation differ?UKDeutsch
How it applies
- Technical documentation: The task is the heart of user and service documentation. Its content model follows the sequence of real work: prerequisites (
<prereq>), context (<context>), steps (<steps>or<steps-unordered>), result (<result>), example and follow-up (<postreq>). - Strict and general task: The general task body allows these sections in any order. The OASIS-supplied task document type applies the strict task body constraint, which fixes the order and allows each section only once — the form most style guides expect.
- Safety: Each
<step>requires exactly one command (<cmd>); hazard statements and notes can be placed in the step where the hazard occurs. DITA 1.3 added<steptroubleshooting>and<tasktroubleshooting>for what to do if a step or task fails. - AI and retrieval: Tasks are the best-structured content for assistants: steps are ordered and machine-identifiable, and prerequisites and results are marked explicitly, so an answer can be generated without losing or reordering steps.
Task vs. troubleshooting topic
A task describes how to reach a goal. A troubleshooting topic starts from a problem — a condition — and describes its causes and remedies.
In DITA markup
<task id="replace-filter">
<title>Replacing the air filter</title>
<taskbody>
<prereq>Switch off the device and disconnect it from the power supply.</prereq>
<steps>
<step><cmd>Open the filter cover.</cmd></step>
<step><cmd>Remove the used filter mat.</cmd></step>
<step><cmd>Insert the new filter mat and close the cover.</cmd>
<stepresult>The cover clicks into place.</stepresult></step>
</steps>
</taskbody>
</task>