API Documentation Workflow

Goal

Document API behavior, authentication, error responses and working request examples.

Inputs

Ask for the intended audience, source material, output format, constraints and success criteria. Use the user's supplied context when available.

Workflow

1. Review the inputs and identify missing facts.
2. Propose a concise structure suited to the audience.
3. Produce original work using the supplied material. Keep a record of external sources and permissions.
4. Check the result against the brief. Verify links, claims, accessibility and relevant technical behavior.
5. Deliver the artifact with a short explanation and any practical limitations.

Quality checklist

• The output solves the user's stated task.
• No invented facts, misleading metrics or unlicensed materials.
• Clear hierarchy, consistent formatting and readable content.
• Editable source and an appropriate final export are included when applicable.

Compatibility

Works with any agent that can read SKILL.md. External generation tools are optional and require the user's configured provider.