How DITA Topic Types Structure XML Technical Writing

The Darwin Information Typing Architecture (DITA) is an XML-based open standard designed to organize technical documentation into modular, standalone units of information called topics. Instead of writing monolithic chapters, technical communicators categorize content into three core information types: concept, task, and reference. This article explores how these DITA topic types structure XML technical writing, enforce semantic separation, and improve documentation quality and reuse.

The Principle of Information Typing

Information typing is the practice of categorizing content based on the user’s immediate need. DITA enforces this practice at the XML schema level. Rather than focusing on document formatting (such as bolding or page breaks), DITA focuses on semantic intent.

By utilizing distinct XML schemas for different content types, DITA prevents authors from mixing background theory, actionable steps, and reference data within the same structural unit. This separation creates predictable, scannable documentation for users and simplifies content management for authors.

1. Concept Topics: Explaining the “What” and “Why”

Concept topics provide background information, definitions, system architecture overviews, and theoretical explanations. They answer questions such as “What is this feature?” or “Why should I use this workflow?”

XML Structure of a Concept

A concept topic uses the <concept> root element, containing a <conbody> (concept body) designed for unstructured, descriptive content.

Key XML tags within <conbody> include: * <p>: Paragraphs providing narrative explanations. * <section>: Titled sub-sections for organizing sub-concepts. * <ul> / <ol>: Standard bulleted or numbered lists for non-sequential items. * <fig>: Diagrams or illustrations that explain a system.

Concept topics intentionally lack strict procedural tags like steps or command syntax, ensuring the author focuses exclusively on comprehension rather than execution.

2. Task Topics: Explaining the “How-To”

Task topics are strictly procedural. They answer the question “How do I perform a specific action?” A well-structured task guides the user from a predefined starting state to a verified end state using sequential instructions.

XML Structure of a Task

A task topic uses the <task> root element and contains a <taskbody>, which strictly enforces the order of procedural elements:

  1. <prereq>: What the user must know, possess, or configure before starting the task.
  2. <context>: A brief background note explaining the scenario or goal of the procedure.
  3. <steps>: The sequential container for the procedure.
    • <step>: An individual action item.
    • <cmd>: The mandatory imperative instruction within a step (e.g., “Click Save”).
    • <info>: Optional supporting detail for that specific step.
    • <stepresult>: The immediate feedback or outcome of that specific action.
  4. <result>: The overall outcome of completing all steps.
  5. <example>: A practical illustration of the completed task.
  6. <postreq>: Next steps or cleanup operations required after completion.

By standardizing these tags, DITA ensures that every procedure across an organization follows the exact same logical flow.

3. Reference Topics: Fact-Based Lookup Data

Reference topics contain quick-lookup, non-narrative information. They are designed for experienced users who need fast access to specific values, command options, API endpoints, error codes, or hardware specifications.

XML Structure of a Reference

A reference topic uses the <reference> root element, containing a <refbody> optimized for structured data rather than flowing paragraphs:

Reference topics discourage narrative prose and completely forbid sequential task steps.

How DITA XML Enforces Technical Writing Quality

The structural segregation of concept, task, and reference provides several technical advantages: