Skip to content

Structured authoring

Documentation pages on Structured authoring (7 pages).

  • Formats and tools

    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

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

  • Information types

    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

    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

    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

    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?

    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