Skip to content
Olivier CarrèreTechnical writing practice

Markdown

Documentation pages on Markdown (8 pages).

This topic brings together 8 pages across the manual:

2 Concepts1 Task5 References

  • About this manual’s API

    Reference

    This manual exposes its entire corpus as a static, zero-runtime API for LLMs and AI agents — llms.txt, per-page Markdown mirrors, and JSON indexes. What it's for and how to use it.

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

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

  • Template: API documentation

    Reference

    Learning path: 5. Build your toolkitAPI documentation

    A ready-to-copy Markdown template for documenting a single REST API endpoint - overview, method, parameters, request/response examples, and error codes.

  • 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