Agent skill · writing content · sickn33
api-documentation
API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation.
Why this skill is useful
Provides a structured workflow for generating OpenAPI specs and comprehensive API documentation that the AI wouldn't reliably generate on its own.
What it needs
About 2k tokens when loaded. Last updated 2026-08-07. 44,571 stars on the source repository.
What this skill does
API Documentation Workflow Overview Specialized workflow for creating comprehensive API documentation including OpenAPI/Swagger specs, developer guides, code examples, and interactive documentation. When to Use This Workflow Use this workflow when: Creating API documentation Generating OpenAPI specs Writing developer guides Adding code examples Setting up API portals Scope and execution Choose the phases that match the user’s task; this document is an index, not an instruction to run every listed skill. Read a selected skill before using it. Respect repository and user constraints. Cloud calls, host configuration, publishing, destructive operations and spending require the applicable authorization; a workflow checklist does not grant it. Base the contract on the actual implementation/specification and keep secrets out of examples. “Try it” can send real requests: use explicit sandbox endpoints and test credentials. Preview documentation locally before publishing; deployment is a separate authorized action. Workflow Phases Phase 1: API Discovery Skills to Invoke api-documenter - API documentation api-design-principles - API design Actions 1. Inventory endpoints 2. Document request/response 3. Identify authentication 4. Map error codes 5. Note rate limits Copy-Paste Prompts Phase 2: OpenAPI Specification Skills to Invoke openapi-spec-generation - OpenAPI api-documenter - API specs Actions 1. Create OpenAPI schema 2. Define paths 3. Add schemas 4. Configure security 5. Add examples Copy-Paste Prompts Phase 3: Developer Guide Skills to Invoke api-documentation-generator - Documentation documentation-templates - Templates Actions 1. Create getting started 2. Write authentication guide 3. Document common patterns 4. Add troubleshooting 5. Create FAQ Copy-Paste Prompts Phase 4: Code Examples Skills to Invoke api-documenter - Code examples tutorial-engineer - Tutorials Actions 1. Create example requests 2. Write SDK examples 3. Add curl examples 4. Create tutorials 5. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills sickn33/api-documentation