Language & documentation · Standard
DITA
Author reusable documentation topics and assemble them for different publications.
What it helps you do
Manage documentation whose reusable information must appear consistently in several products, guides, or delivery formats.
Starting knowledge: Some familiarity with structured documentation and XML helps.
- Write a topic around a bounded reader need.
- Use maps to assemble topics into a publication.
- Use controlled reuse and specialization deliberately, with ownership for shared material.
The problem it came from
DITA originated at IBM and became an OASIS standard in 2005. Its name is Darwin Information Typing Architecture.
The OASIS 1.3 overview explains topic-based authoring, maps, specialization, and reuse. This entry uses that edition as its reference rather than claiming it is the latest edition.
Work through an example
Topic: cancel-registration
Purpose: cancel an existing workshop registration.
Prerequisite: a confirmed registration.
Steps: open booking; choose cancel; confirm.
Map A: participant guide → cancel-registration
Map B: organizer help → cancel-registration- This is a conceptual sketch, not DITA XML.
- Reuse has a named source instead of several untracked copies.
- Publication context still needs review: shared steps may have different prerequisites.
Where it helps. Where it stops.
Use it when
- A help collection repeats the same task across product editions.
- Several manuals must share reviewed warnings and reference material.
Potential benefits
- A shared topic can reduce contradictory copies.
- Separating content from assembly supports several publication structures.
Limits and common mistakes
- Adopting XML without a content model does not produce useful reuse.
- Tooling, specialization, and shared ownership can cost more than they save for a small one-off article.
The prompt below asks for this structure. It does not guarantee accuracy, complete coverage, better learning, or conformance to a standard. Treat those outcomes as separate checks.
Practise the judgment
Try a choice, inspect a boundary, then explain a case yourself. Hints and answers are available whenever you need them.
Which is the strongest reason to consider DITA?
Hint
Look for repeated content with a lifecycle.
Explained answer
Best answer for this case: Repeated maintained content across multiple guides
DITA addresses structured authoring and reuse, whose benefits become relevant across maintained publications.
A shared topic changes. What still needs review?
Hint
Reuse propagates mistakes as well as corrections.
Explained answer
Best answer for this case: Every context in which it is assembled
A correct shared topic may become inappropriate for one publication context.
Two manuals share setup steps but use different warnings. How would you structure the reuse?
Hint
Reuse is a design choice, not a word-count target.
Explained answer & self-review rubric
Reuse the genuinely common setup material. Keep product-specific warnings attached to their correct contexts and review each assembled manual. Do not force incompatible instructions into a universal topic.
- Identify genuinely shared content
- Keep context-specific constraints
- Review assembled outputs
Take it into your own work
Manual template
Use this structure yourself, with a colleague, or in your preferred writing tool.
# Topic and reuse plan
Topic ID:
Topic type and reader need:
Prerequisites:
Content:
Shared references:
Maps that include this topic:
Owner and change review:
Review the result
- Does the topic make sense in every assembly?
- Are references and identifiers stable?
- Is reuse reducing actual duplication?
Use this approach with your own AI tool
Help me apply DITA to the material below.
Reader and existing knowledge: [describe]
Task and desired outcome: [describe]
Use these principles: Write a topic around a bounded reader need.; Use maps to assemble topics into a publication.; Use controlled reuse and specialization deliberately, with ownership for shared material..
Preserve source facts, identifiers, quantities, conditions, exceptions, and uncertainty.
Separate supplied facts from assumptions. Ask for missing information instead of inventing it.
Explain your representation choices and provide a review checklist. Do not claim formal compliance or correctness from formatting alone.
Material: [paste only information you are permitted to share]Go to the source
History and the underlying approach are grounded in these references. Examples, prompts, and practice cases here are original educational adaptations. Edition-specific details should be checked against the referenced publication.
Last editorial review: 2026-10-24. An overview is not certification, and this guide is not a reproduction of a standard.