Skip to content

Technical Reference template

Canonical template for the Technical Reference format.

# [Component / Function / Concept Name]
[One sentence: what this is and what it does. No background.]
## Syntax / Signature

[Exact syntax or function signature]

## Parameters / Fields / Options
| Name | Type | Required | Description |
|------|------|----------|-------------|
| [name] | [type] | [yes/no] | [concise description] |
## Returns / Output
[What is returned or produced - type and structure]
## Examples
```[language]
[Working minimal example]

[Optional: second example showing edge case or variation]

  • [Important limitation, gotcha, or version note]
  • [Related component or concept] - [link or cross-reference]