doc-api
Domain: doc · Model class: free
Description
Section titled “Description”Use this skill when the user wants to work on Generating schema-driven API reference documentation with examples and contracts. Triggers include “document this API”, “generate API reference docs”, “OpenAPI documentation”. Do NOT use when generate general project docs (use core-documentation-generator).
Purpose
Section titled “Purpose”Generating schema-driven API reference documentation with examples and contracts. This skill provides structured guidance, references, and worked examples to help produce high-quality, actionable outputs.
Trigger Phrases
Section titled “Trigger Phrases”- “document this API”
- “generate API reference docs”
- “OpenAPI documentation”
- “API endpoint documentation with examples”
Anti-Triggers
Section titled “Anti-Triggers”- generate general project docs (use core-documentation-generator)
- write a user guide (use core-documentation-generator)
Intake Questions
Section titled “Intake Questions”- What is the user’s goal and current state?
- What constraints (time, team, compliance) apply?
- Are there existing artifacts (specs, code, benchmarks) to reference?
Output Contract
Section titled “Output Contract”- documentation artifact
- audience-aware structure
- source-aware coverage
- publication or validation checklist