One or two sentences on what this document is and who it is for. Plain and direct, sentence case, no exclamation mark.
Body copy sits at 12.5px. Keep paragraphs short. Inline references to code, fields, or
files go in monospace so they are unmistakable in a printed page.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| identifier | String | Yes | What it is and what the reader should pass. One sentence. |
| count | Number | No | Defaults are worth stating here rather than in a footnote. |
Anything the reader might copy goes in a block rather than inline.
{
"id": "example",
"count": 1250,
"nested": { "ok": true },
"updated_at": "2026-01-01T00:00:00Z"
}
A caption explains what the reader is looking at, if it isn't obvious.
# run it once per session export EXAMPLE_TOKEN="paste-here" curl -H "authorization: Bearer $EXAMPLE_TOKEN" \ "https://example.com/v1/resource?id=example"
Close with the handful of things that will actually trip someone up, one per line.
Questions: info@may.inc