Skip to content
Olivier CarrèreTechnical writing practice

Information typing

Documentation pages on Information typing (6 pages).

This topic brings together 6 pages across the manual:

2 Concepts1 Task3 References

  • Example: a well-structured Markdown page

    Task

    Learning path: 5. Build your toolkitWorked examples

    A worked example of a concept article in Markdown, annotated to show why each structural choice was made.

  • 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.

  • 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.

  • Template: concept article

    Reference

    Learning path: 5. Build your toolkitTemplates

    A practical authoring template for writing a concept article — an information type answering 'What is it?' with definitions, context, principles, and examples.

  • Template: reference article

    Reference

    Learning path: 5. Build your toolkitTemplates

    A ready-to-copy Markdown template for writing a reference article, following the Overview / Syntax / Parameters / Examples / Limitations structure.

  • Template: task article

    Reference

    Learning path: 5. Build your toolkitTemplates

    A ready-to-copy Markdown template for writing a task/tutorial article, following the Objective / Prerequisites / Steps / Expected result / Troubleshooting structure.

All topics