Authoring API Docs Action

Produces precise, exhaustive API reference documentation — the information-oriented quadrant of the Diátaxis framework.

Load authoring-technical-docs first for the multi-pass workflow, style rules, and quality framework. This action provides the templates and API-specific rules.

Templates

Templates are located in the assets/ folder alongside this skill:

• assets/rest-endpoint-template.md — Use for documenting individual REST API endpoints. Covers authentication, path/query/body parameters, request and response examples, error codes, and rate limits.
• assets/sdk-function-template.md — Use for documenting SDK or library functions. Covers parameters, options, return values, errors, and a usage example.

Copy the relevant template and fill in all placeholder fields before publishing.