Skip to content
Olivier CarrèreTechnical writing practice

Structured authoring

Documentation pages on Structured authoring (7 pages).

This topic brings together 7 pages across the manual:

7 Concepts

  • Formats and tools

    Concept

    Learning path: 4. Choose an authoring modelSource vs target formats

    When industrializing technical writing, the format matters more than the tool. Compare proprietary formats like Word and FrameMaker against open standards like DITA XML and DocBook to find the right fit.

  • From document to modular document base

    Concept

    Learning path: 4. Choose an authoring model

    DITA XML structured authoring moves documentation from monolithic books to a modular content base, enabling topic reuse, efficient translation, and multichannel output.

  • Information types

    Concept

    Learning path: 1. Understand documentation

    Understand information typing in technical documentation: how Concept, Task, and Reference divide content by reader intent, and how this relates to DITA, Markdown, and OpenAPI.

  • Source format

    Concept

    Learning path: 4. Choose an authoring modelSource vs target formats

    Word processors have unaccustomed us to distinguishing between form and content. But confusing the two leads to many errors and wasted time.

  • Structured and unstructured formats

    Concept

    Learning path: 4. Choose an authoring modelStructured authoring

    Compare structured formats (DITA XML, DocBook) and unstructured formats (Word, PDF) for technical documentation: understand the trade-offs for reuse and translation.

  • The three levels of technical documentation

    Concept

    Learning path: 1. Understand documentation

    Compare the three maturity levels of technical documentation - from informal notes to modular structured content - and see what sets each stage apart.

  • Too complex a document architecture?

    Concept

    Learning path: 4. Choose an authoring modelDITA

    DITA XML enables productivity gains by reducing the source volume that the technical writer creates, translates and maintains, at the cost of greater complexity.

All topics