Elite API Documentation

Use this skill to produce API documentation that helps developers succeed quickly, reason accurately, and operate safely in production. Treat documentation as part of the API contract, not as marketing copy or after-the-fact explanation.

Core Standard

Elite API documentation must be:

• True: technically accurate, verified against the implementation, schema, SDK, or authoritative source.
• Findable: organized around user intent, system concepts, and predictable reference structure.
• Executable: examples are complete, realistic, current, and runnable where possible.
• Operational: covers errors, limits, retries, security, observability, versioning, migration, and production failure.
• Maintainable: tied to owners, source-of-truth artifacts, release workflows, tests, and freshness checks.
• Humane: respects the developer's time, context, uncertainty, and production risk.

If these goals conflict, preserve truth first, then usability, then elegance.

Immutable Laws