Skip to content
Olivier CarrèreTechnical writing practice

API documentation

Documentation pages on API documentation (3 pages).

This topic brings together 3 pages across the manual:

1 Concept2 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.

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

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

All topics