# documentation-generator

> Generate comprehensive, maintainable, and accessible technical documentation covering all aspects of the application

- Author: Muhammad Hamza
- Repository: hamzasheedi/todo_app
- Version: 20260203111530
- Stars: 1
- Forks: 0
- Last Updated: 2026-02-07
- Source: https://github.com/hamzasheedi/todo_app
- Web: https://mule.run/skillshub/@@hamzasheedi/todo_app~documentation-generator:20260203111530

---

---
name: documentation-generator
description: Generate comprehensive, maintainable, and accessible technical documentation covering all aspects of the application
---

# Documentation Generator Skill

## Purpose

This skill should be used when generating comprehensive, maintainable, and accessible technical documentation covering all aspects of the Phase II Todo Full-Stack Web Application. The skill focuses on creating clear, up-to-date, and useful documentation that serves both developers and end users.

## When to Use This Skill

Use this skill when:
- Creating API documentation with examples and usage
- Writing architecture decision records and system design
- Generating user guides and feature documentation
- Creating deployment and operations documentation
- Maintaining technical documentation with code changes
- Producing security and compliance documentation

## How to Use This Skill

### API Documentation
1. Generate comprehensive API endpoint documentation
2. Include request/response examples and schemas
3. Document authentication and authorization requirements
4. Add error response examples and codes
5. Include API versioning information
6. Create interactive API documentation where possible
7. Maintain API documentation with code changes

### Architecture Documentation
1. Create architecture decision records (ADRs)
2. Document system architecture and components
3. Include data flow and interaction diagrams
4. Document technology stack and dependencies
5. Create deployment architecture diagrams
6. Include security architecture documentation
7. Maintain architecture documentation with system changes

### User Documentation
1. Create comprehensive user guides and tutorials
2. Document feature usage and workflows
3. Include troubleshooting guides and FAQs
4. Add accessibility documentation and guidelines
5. Create onboarding documentation for new users
6. Include best practices and recommendations
7. Maintain user documentation with feature changes

### Development Documentation
1. Create contribution and development guides
2. Document code standards and conventions
3. Include testing procedures and guidelines
4. Add deployment and environment setup guides
5. Create security implementation documentation
6. Include performance optimization guides
7. Maintain development docs with codebase changes

### Maintenance and Updates
1. Implement documentation generation from code
2. Create automated documentation updates
3. Include versioning and change tracking
4. Add documentation review and approval processes
5. Implement documentation quality checks
6. Create documentation feedback mechanisms
7. Establish documentation maintenance procedures

### Accessibility and Usability
1. Ensure documentation follows accessibility standards
2. Create clear, jargon-free language
3. Include visual aids and diagrams
4. Implement proper navigation and search
5. Add examples and use cases
6. Include cross-references and links
7. Ensure mobile-friendly documentation

## Available Resources

### API Documentation Templates
- Use `/docs/api_templates/` for API documentation
- Follow OpenAPI/Swagger conventions
- Include proper error response examples
- Maintain comprehensive endpoint documentation

### Architecture Documentation
- Reference `/docs/architecture.md` for architecture documentation
- Follow established patterns for consistency
- Include proper diagrams and visual aids
- Implement comprehensive system documentation

### User Guides
- Use `/docs/user_guide.md` for user interface documentation
- Follow established patterns for consistency
- Include proper examples and tutorials
- Implement comprehensive user documentation

### Development Guides
- Reference `/docs/contributing.md` for development guidelines
- Follow established patterns for consistency
- Include proper standards and procedures
- Implement comprehensive development documentation

### Security Documentation
- Use `/docs/security.md` for security implementation
- Follow established patterns for consistency
- Include proper security procedures
- Implement comprehensive security documentation

## Output Standards

When generating documentation:
1. Ensure comprehensive coverage of all system aspects
2. Include proper examples and usage scenarios
3. Implement automated documentation generation where possible
4. Use consistent formatting and structure across all docs
5. Document all features with proper examples and tutorials
6. Implement proper versioning and change tracking
7. Optimize for accessibility and usability
8. Follow documentation best practices and standards
9. Maintain documentation with code and feature changes
10. Create comprehensive documentation that serves all stakeholders