Topic-based Writing
Topic-based writing in DITA emphasizes modularity, reusability, conciseness, and separation of content from output form, to create effective and accessible technical documentation that can be delivered through multiple channels.
Darwin Information Typing Architecture (DITA) is a disciplined approach to writing that emphasizes modularity and reuse of concise units of information called topics. DITA provides a standardized framework for creating effective topic-based content. This method is particularly well-suited for technical and product-related information, where readers often need quick access to specific information, rather than reading an entire document sequentially.
The two main structure types in DITA are topics and maps. Topics are the basic building blocks that contain content. Maps arrange topics and other resources into structured collections for establishing hierarchy and relationships within the content set.
The core principles of topic-based writing are: modularity, reusability, conciseness, and separation of content from form.
- Modularity
-
The practice of treating each piece of content - a topic - both as an independent unit that can stand alone and also function as part of a larger document structure. Main principles to follow:
Address one subject, task, or concept
Maintain independence from other topics
Include all necessary context within itself
Function both independently and as part of larger information sets
- Reusability
-
The practice of maximizing content efficiency by enabling topics to be used in multiple contexts and deliverables. Main principles to follow:
Create topics that are context-neutral, where possible
Avoid references to specific document structures or other topics
Use consistent terminology and writing style
Design topics to serve multiple audience needs
Implement metadata and conditional processing for efficient content retrieval
- Conciseness
-
The practice of ensuring each topic contains only the information necessary to serve its specific purpose. Main principles to follow:
Eliminate redundant information
Use clear, direct language
Focus on a single main idea per topic
Remove unnecessary context or background information
Break complex subjects into manageable chunks
- Separation of Content and Format
-
The practice of keeping content independent from its presentation format to enable flexible content delivery across multiple channels and platforms. Main principles to follow:
Allow content to be published in various output formats without rewriting
Maintain consistent structure regardless of output
Enable automated formatting through style sheets and templates
Facilitate content updates without affecting formatting
Support multiple delivery channels from a single source