/generate-api-documentation
Auto-generate API reference documentation
$ npx -y skills add qdhenry/Claude-Command-Suite --agent claude-codeHow it fires
How this command gets triggered: by you, by Claude, or both.
- Fires itselfClaude auto-loads it when your prompt matches the work.
- You can call itInvoke it directly when you want it.
- Slash command
/generate-api-documentation
Context preview
What this command does when you run it.
Auto-generate API reference documentation
Command definition
generate-api-documentation.mdGenerate API Documentation
Auto-generate API reference documentation
Instructions
1. **API Documentation Strategy Analysis**
- Analyze current API structure and endpoints
- Identify documentation requirements (REST, GraphQL, gRPC, etc.)
- Assess existing code annotations and documentation
- Determine documentation output formats and hosting requirements
- Plan documentation automation and maintenance strategy
2. **Documentation Tool Selection**
- Choose appropriate API documentation tools:
- **OpenAPI/Swagger**: REST API documentation with Swagger UI
- **Redoc**: Modern OpenAPI documentation renderer
- **GraphQL**: GraphiQL, Apollo Studio, GraphQL Playground
- **Postman**: API documentation with collections
- **Insomnia**: API documentation and testing
- **API Blueprint**: Markdown-based API documentation
- **JSDoc/TSDoc**: Code-first documentation generation
- Consider factors: API type, team workflow, hosting, interactivity
3. **Code Annotation and Schema Definition**
- Add comprehensive code annotations for API endpoints
- Define request/response schemas and data models
- Add parameter descriptions and validation rules
- Document authentication and authorization requirements
- Add example requests and responses
4. **API Specification Generation**
- Set up automated API specification generation from code
- Configure OpenAPI/Swagger specification generation
- Set up schema validation and consistency checking
- Configure API versioning and changelog generation
- Set up specification file management and version control
5. **Interactive Documentation Setup**
- Configure interactive API documentation with try-it-out functionality
- Set up API testing and example execution
- Configure authentication handling in documentation
- Set up request/response validation and examples
- Configure API endpoint categorization and organization
6. **Documentation Content Enhancement**
- Add comprehensive API guides and tutorials
- Create authentication and authorization documentation
- Add error handling and status code documentation
- Create SDK and client library documentation
- Add rate limiting and usage guidelines
7. **Documentation Hosting and Deployment**
- Set up documentation hosting and deployment
- Configure documentation website generation and styling
- Set up custom domain and SSL configuration
- Configure documentation search and navigation
- Set up documentation analytics and usage tracking
8. **Automation and CI/CD Integration**
- Configure automated documentation generation in CI/CD pipeline
- Set up documentation deployment automation
- Configure documentation validation and quality checks
- Set up documentation change detection and notifications
- Configure documentation testing and link validation
9. **Multi-format Documentation Generation**
- Generate documentation in multiple formats (HTML, PDF, Markdown)
- Set up downloadable documentation packages
- Configure offline documentation access
- Set up documentation API for programmatic access
- Configure documentation syndication and distribution
10. **Maintenance and Quality Assurance**
- Set up documentation quality monitoring and validation
- Configure documentation feedback and improvement workflows
- Set up documentation analytics and usage metrics
- Create documentation maintenance procedures and guidelines
- Train team on documentation best practices and tools
- Set up documentation review and approval processes
Read more
Generate API Documentation
Auto-generate API reference documentation
Instructions
1. **API Documentation Strategy Analysis**
- Analyze current API structure and endpoints
- Identify documentation requirements (REST, GraphQL, gRPC, etc.)
- Assess existing code annotations and documentation
- Determine documentation output formats and hosting requirements
- Plan documentation automation and maintenance strategy
2. **Documentation Tool Selection**
- Choose appropriate API documentation tools:
- **OpenAPI/Swagger**: REST API documentation with Swagger UI
- **Redoc**: Modern OpenAPI documentation renderer
- **GraphQL**: GraphiQL, Apollo Studio, GraphQL Playground
- **Postman**: API documentation with collections
- **Insomnia**: API documentation and testing
- **API Blueprint**: Markdown-based API documentation
- **JSDoc/TSDoc**: Code-first documentation generation
- Consider factors: API type, team workflow, hosting, interactivity
3. **Code Annotation and Schema Definition**
- Add comprehensive code annotations for API endpoints
- Define request/response schemas and data models
- Add parameter descriptions and validation rules
- Document authentication and authorization requirements
- Add example requests and responses
4. **API Specification Generation**
- Set up automated API specification generation from code
- Configure OpenAPI/Swagger specification generation
- Set up schema validation and consistency checking
- Configure API versioning and changelog generation
- Set up specification file management and version control
5. **Interactive Documentation Setup**
- Configure interactive API documentation with try-it-out functionality
- Set up API testing and example execution
- Configure authentication handling in documentation
- Set up request/response validation and examples
- Configure API endpoint categorization and organization
6. **Documentation Content Enhancement**
- Add comprehensive API guides and tutorials
- Create authentication and authorization documentation
- Add error handling and status code documentation
- Create SDK and client library documentation
- Add rate limiting and usage guidelines
7. **Documentation Hosting and Deployment**
- Set up documentation hosting and deployment
- Configure documentation website generation and styling
- Set up custom domain and SSL configuration
- Configure documentation search and navigation
- Set up documentation analytics and usage tracking
8. **Automation and CI/CD Integration**
- Configure automated documentation generation in CI/CD pipeline
- Set up documentation deployment automation
- Configure documentation validation and quality checks
- Set up documentation change detection and notifications
- Configure documentation testing and link validation
9. **Multi-format Documentation Generation**
- Generate documentation in multiple formats (HTML, PDF, Markdown)
- Set up downloadable documentation packages
- Configure offline documentation access
- Set up documentation API for programmatic access
- Configure documentation syndication and distribution
10. **Maintenance and Quality Assurance**
- Set up documentation quality monitoring and validation
- Configure documentation feedback and improvement workflows
- Set up documentation analytics and usage metrics
- Create documentation maintenance procedures and guidelines
- Train team on documentation best practices and tools
- Set up documentation review and approval processes
A comprehensive development toolkit designed following Anthropic's Claude Code Best Practices for AI-assisted software development.
Repo: qdhenry/Claude-Command-Suite
Other commands on claude-command-suite.
- /boundary-bbcr-fallback
Execute automatic BBCR (Collapse-Rebirth Correction) when knowledge boundaries are exceeded or reasoning fails.
Open command - /boundary-detect
Analyze semantic position relative to knowledge boundaries to prevent hallucination and identify uncertainty zones.
Open command - /boundary-heatmap
Generate a visual heatmap of knowledge boundaries showing safe zones, risk areas, and semantic coverage.
Open command - /boundary-risk-assess
Evaluate the current risk level and provide detailed analysis of potential hallucination or reasoning failure.
Open command - /boundary-safe-bridge
Find and construct semantic bridges to safely navigate from current position to target concept without crossing dangerous boundaries.
Open command - /optimize-prompt
Takes an input prompt and returns ONLY a token-optimized version that preserves meaning while minimizing token count. Based on LLM tokenization principles: common words tokenize more efficiently, unusual words break into more tokens, and conciseness reduces cost.
Open command