quality-review-documentation

Documentation Quality Review and Assessment

This prompt provides comprehensive evaluation of project documentation including technical docs, user guides, API documentation, and maintenance materials with actionable improvement recommendations.

🎯 DOCUMENTATION REVIEW OBJECTIVES:

1. ASSESS documentation completeness across all project areas
2. EVALUATE content quality including accuracy, clarity, and usefulness
3. REVIEW structure and organization for logical flow and discoverability
4. VALIDATE user experience from different audience perspectives
5. IDENTIFY maintenance gaps and sustainability issues

📚 DOCUMENTATION INVENTORY AND ANALYSIS:

STEP 1: Documentation Discovery and Categorization

Automated Documentation Inventory:

# Discover all documentation files
echo "📋 Discovering project documentation..."

# Find markdown files
echo "## Markdown Documentation:"
find . -name "*.md" -not -path "./node_modules/*" -not -path "./.git/*" | sort

# Find documentation directories
echo -e "\n## Documentation Directories:"
find . -type d -name "*doc*" -o -name "*guide*" -o -name "*manual*" | grep -v node_modules | sort

# Find README files
echo -e "\n## README Files:"
find . -name "README*" -not -path "./node_modules/*" | sort

# Find API documentation
echo -e "\n## API Documentation:"
find . -name "*.yaml" -o -name "*.yml" -o -name "swagger*" -o -name "openapi*" | grep -v node_modules | sort

# Find JSDoc/TypeDoc files
echo -e "\n## Code Documentation:"
find . -name "*.jsdoc" -o -name "typedoc.json" | grep -v node_modules | sort

# Check for documentation generators
echo -e "\n## Documentation Tools:"
[ -f "package.json" ] && grep -E "(jsdoc|typedoc|docusaurus|vitepress|gitbook)" package.json || echo "No documentation tools found in package.json"

Documentation Categories Assessment:

## Documentation Categories Checklist

### Project Overview Documentation:
- [ ] **Main README.md** - Project introduction and quick start
- [ ] **CONTRIBUTING.md** - Contribution guidelines
- [ ] **CHANGELOG.md** - Version history and changes
- [ ] **LICENSE** - Legal and usage terms
- [ ] **CODE_OF_CONDUCT.md** - Community guidelines

### Technical Documentation:
- [ ] **Architecture Documentation** - System design and structure
- [ ] **API Documentation** - Endpoint specifications and examples
- [ ] **Database Schema** - Data model and relationships
- [ ] **Deployment Guides** - Installation and deployment procedures
- [ ] **Configuration Guides** - Environment setup and options

### User Documentation:
- [ ] **User Guides** - End-user instruction manuals
- [ ] **Tutorials** - Step-by-step learning materials
- [ ] **FAQ** - Frequently asked questions
- [ ] **Troubleshooting** - Problem resolution guides
- [ ] **Examples** - Working code samples and demos

### Developer Documentation:
- [ ] **Setup Instructions** - Development environment setup
- [ ] **Coding Standards** - Style guides and conventions
- [ ] **Testing Documentation** - Testing strategies and procedures
- [ ] **Security Guidelines** - Security best practices
- [ ] **Performance Guidelines** - Optimization recommendations

### Operational Documentation:
- [ ] **Monitoring Guides** - System monitoring and alerting
- [ ] **Backup Procedures** - Data backup and recovery
- [ ] **Disaster Recovery** - Business continuity plans
- [ ] **Runbooks** - Operational procedures
- [ ] **Incident Response** - Emergency response procedures