Generate Comprehensive API Documentation
A 7-phase workflow sequencing API discovery, OpenAPI spec, developer guides, examples, interactive docs, and maintenance.
Why it matters
Automate the creation of complete API documentation, including OpenAPI specifications, developer guides, code examples, and interactive documentation portals.
Outcomes
What it gets done
Generate OpenAPI/Swagger specifications
Write developer guides and tutorials
Create code examples and SDK snippets
Set up interactive documentation interfaces
Install
Add it to your toolbox
Run in your project directory:
curl -fsSL https://spark.entire.vc/get/ag-api-documentation | bash Overview
API Documentation Workflow
A 7-phase workflow sequencing API documentation work: discovery, OpenAPI spec generation, developer guide, code examples, interactive docs, site architecture, and maintenance. Use it as the overarching roadmap when multiple API documentation concerns need to be sequenced together - not a substitute for the specialist skills it names.
What it does
This workflow coordinates a complete API documentation build across seven phases, each naming specific skills to invoke: Phase 1 API Discovery (api-documenter, api-design-principles - inventory endpoints, document request/response, identify auth, map error codes, note rate limits); Phase 2 OpenAPI Specification (openapi-spec-generation, api-documenter - schema, paths, security config, examples); Phase 3 Developer Guide (api-documentation-generator, documentation-templates - getting started, auth guide, common patterns, troubleshooting, FAQ); Phase 4 Code Examples (api-documenter, tutorial-engineer - example requests, SDK examples, curl examples, tutorials); Phase 5 Interactive Docs (api-documenter - Swagger UI, Redoc, try-it functionality); Phase 6 Documentation Site (docs-architect, wiki-page-writer - platform choice, structure, navigation, search); and Phase 7 Maintenance (api-documenter - auto-generation setup, validation, review process, scheduled updates). Each phase ends in a copy-paste prompt naming the skill to invoke, for example:
Use @api-documenter to discover and document API endpoints
Use @openapi-spec-generation to create OpenAPI specification
Use @api-documentation-generator to create developer guide
Use @api-documenter to generate code examples
Use @api-documenter to set up interactive documentation
Use @docs-architect to design API documentation site
Use @api-documenter to set up automated doc generation
Quality gates check that the OpenAPI spec is complete, the developer guide is written, code examples work, interactive docs are functional, and documentation is deployed before considering the work done.
When to use - and when NOT to
Use this as the overarching roadmap when creating API documentation, generating OpenAPI specs, writing developer guides, adding code examples, or setting up an API documentation portal - anywhere multiple documentation concerns need to be sequenced together.
Not a substitute for the specialist skills it names - each phase delegates the actual work to a dedicated skill (api-documenter, openapi-spec-generation, docs-architect, tutorial-engineer, etc.). Use this to know what to build in what order, not as the implementation itself.
Inputs and outputs
Inputs: an existing or planned API whose endpoints, auth, error codes, and rate limits need documenting.
Outputs: a complete OpenAPI/Swagger specification, a developer guide (getting started, auth, patterns, troubleshooting, FAQ), working code examples (SDK and curl), interactive documentation (Swagger UI/Redoc with try-it functionality), a deployed documentation site, and an ongoing maintenance process for keeping docs current.
Integrations
Delegates to api-documenter, api-design-principles, openapi-spec-generation, api-documentation-generator, documentation-templates, tutorial-engineer, docs-architect, and wiki-page-writer skills; related bundles include documentation, api-development, and development.
Who it's for
Teams building comprehensive API documentation from scratch who need a sequenced roadmap across discovery, spec generation, guides, examples, interactive docs, site architecture, and maintenance.
FAQ
Common questions
Discussion
Questions & comments · 0
Sign In Sign in to leave a comment.