wehub-resource-sync
1 line
5.0 KiB
JSON
1 line
5.0 KiB
JSON
{"content": "---\nallowed-tools: Read, Write, Edit, Bash, Grep\nargument-hint: [maintenance-type] | --audit | --update | --validate | --optimize | --comprehensive\ndescription: Use PROACTIVELY to implement comprehensive documentation maintenance systems with quality assurance, validation, and automated updates\n---\n\n# Documentation Maintenance & Quality Assurance\n\nImplement comprehensive documentation maintenance system: $ARGUMENTS\n\n## Current Documentation Health\n\n- Documentation files: !`find . -name \"*.md\" -o -name \"*.mdx\" | wc -l` files\n- Last updates: !`find . -name \"*.md\" -exec stat -f \"%m %N\" {} \\; | sort -n | tail -5`\n- External links: !`grep -r \"http\" --include=\"*.md\" . | wc -l` links to validate\n- Image references: !`grep -r \"!\\[.*\\]\" --include=\"*.md\" . | wc -l` images to check\n- Documentation structure: @docs/ or detect documentation directories\n\n## Task\n\nCreate systematic documentation maintenance framework with automated quality assurance, comprehensive validation, content optimization, and regular update procedures.\n\n## Documentation Maintenance Framework\n\n### 1. Content Quality Audit System\n- Comprehensive file discovery and categorization\n- Content freshness analysis and aging detection\n- Word count, readability, and structure assessment\n- Missing sections and incomplete documentation identification\n- TODO/FIXME marker tracking and resolution planning\n\n### 2. Link and Reference Validation\n- External link health monitoring with retry logic\n- Internal link validation and broken reference detection\n- Image reference verification and missing asset identification\n- Cross-reference consistency checking\n- Automated link correction suggestions\n\n### 3. Style and Consistency Checking\n- Markdown syntax validation and formatting standards\n- Heading hierarchy and structure consistency\n- List formatting and emphasis style uniformity\n- Code block formatting and language specification\n- Accessibility compliance (alt text, descriptive links)\n\n### 4. Content Optimization and Enhancement\n- Table of contents generation for long documents\n- Metadata updating and frontmatter management\n- Common formatting issue correction\n- Spelling and grammar validation\n- Readability analysis and improvement suggestions\n\n### 5. Automated Synchronization System\n- Git-based change tracking and documentation updates\n- Version control integration with branch management\n- Automated commit generation with detailed change logs\n- Merge conflict resolution strategies\n- Rollback procedures for failed updates\n\n### 6. Quality Assurance Reporting\n- Comprehensive audit reports with severity classifications\n- Issue categorization and prioritization systems\n- Progress tracking and maintenance metrics\n- Automated notification systems for critical issues\n- Dashboard creation for ongoing monitoring\n\n## Implementation Requirements\n\n### Audit Configuration\n- Configurable quality thresholds and validation rules\n- Custom style guide integration and enforcement\n- Platform-specific optimization settings\n- Team collaboration workflow integration\n- Automated scheduling and recurring maintenance\n\n### Validation Processes\n- Multi-level validation with error categorization\n- Batch processing for large documentation sets\n- Performance optimization for comprehensive scans\n- Integration with existing CI/CD pipelines\n- Real-time monitoring and alerting systems\n\n### Reporting and Analytics\n- Detailed maintenance reports with actionable insights\n- Historical trend analysis and improvement tracking\n- Team productivity metrics and documentation health scores\n- Integration with project management tools\n- Automated stakeholder communication\n\n## Deliverables\n\n1. **Maintenance System Architecture**\n - Automated audit and validation framework\n - Content optimization and enhancement tools\n - Quality assurance reporting infrastructure\n - Version control integration and synchronization\n\n2. **Validation and Quality Tools**\n - Link checking and reference validation systems\n - Style consistency and accessibility compliance tools\n - Content freshness and completeness analyzers\n - Automated correction and enhancement utilities\n\n3. **Reporting and Monitoring**\n - Comprehensive audit reports with prioritized recommendations\n - Real-time monitoring dashboards and alert systems\n - Progress tracking and maintenance history documentation\n - Integration with team communication and project tools\n\n4. **Documentation and Procedures**\n - Implementation guidelines and configuration instructions\n - Team workflow integration and collaboration procedures\n - Troubleshooting guides and maintenance best practices\n - Automated scheduling and recurring maintenance setup\n\n## Integration Guidelines\n\nImplement with existing documentation platforms and development workflows. Ensure scalability for large documentation sets and team collaboration while maintaining quality standards and accessibility compliance."} |