| name | doc-generator |
| description | Generates comprehensive documentation from code, APIs, and specifications. Creates API documentation, developer guides, architecture docs, and user manuals with examples and tutorials. |
| allowed-tools | read, write, glob, search, codebase_search |
| version | 1 |
| best_practices | ["Extract documentation from code comments","Generate OpenAPI/Swagger specs from code","Create comprehensive examples","Include troubleshooting guides","Follow documentation standards"] |
| error_handling | graceful |
| streaming | supported |
| templates | ["api-docs","developer-guide","architecture-docs","user-manual"] |
Documentation Generator Skill - Generates comprehensive documentation from code, APIs, and specifications including API docs, developer guides, architecture documentation, and user manuals.
- Generating API documentation
- Creating developer guides
- Documenting architecture
- Creating user manuals
- Generating OpenAPI/Swagger specs
- Updating existing documentation
Step 1: Identify Documentation Type
Determine documentation type:
- API Documentation: Endpoint references
- Developer Guide: Setup and usage
- Architecture Docs: System overview
- User Manual: Feature guides
Step 2: Extract Information
Gather documentation content:
- Read code and comments
- Analyze API endpoints
- Extract examples
- Understand architecture
Step 3: Generate Documentation
Create documentation:
- Follow documentation templates
- Include examples
- Add troubleshooting
- Create clear structure
Step 4: Validate Documentation
Validate quality:
- Check completeness
- Verify examples work
- Ensure clarity
- Validate links
</execution_process>
**Integration with Technical Writer Agent**:
- Uses this skill for documentation generation
- Ensures documentation quality
- Validates completeness
Integration with Developer Agent:
- Generates API documentation
- Creates inline documentation
- Updates docs with code changes
<best_practices>
- Extract from Code: Use code as source of truth
- Include Examples: Provide working examples
- Keep Updated: Sync docs with code
- Clear Structure: Organize logically
- User-Focused: Write for users, not system
</best_practices>
**API Documentation**
# Users API
## Endpoints
### GET /api/users
List all users with pagination.
**Query Parameters:**
- `page` (number): Page number (default: 1)
- (number): Items per page (default: 10)
