Markdown

• About this manual's API

  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

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

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

• Template: API 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

  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

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

• Template: task article

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

← All topics