awesome-docs/docs/quality.md

Quality Assurance

Tools and practices for ensuring documentation quality, accuracy, and consistency.

Language & Style Tools

Grammar & Writing

• Alex - Catch insensitive, inconsiderate writing
• Harper - Grammar checker for developers
• Vale - Syntax-aware linter for prose
• Woke - Detect non-inclusive language

Style Consistency

• case-police - Make casing consistent
• Capitalize My Title - Title case formatter

Link & Content Validation

Link Checking

• lychee - Fast link checker written in Rust
• Linkspector - Web crawler for broken links
• HtmlTest - HTML validation and link checking
• brok - Find broken links in text files

Content Testing

• Doc Detective - Test documentation accuracy
• Swimm - Keep code documentation synchronized

Accessibility & Readability

Accessibility Testing

• AXE-CLI - Accessibility testing from command line
• Pa11y - Automated accessibility testing
• Lumberjack - Accessibility checker

Readability Analysis

• Readable - Readability score calculator
• Contrastchecker - Color contrast validation

Automation & CI/CD

Automated Testing

• Your automated tester - Documentation testing platform
• InnovationEngine - Content analysis and suggestions

Quality Assurance Workflow

Pre-Publishing Checklist

1. Grammar & Style - Run through Alex, Vale, or similar tools
2. Link Validation - Check all internal and external links
3. Accessibility - Ensure content meets accessibility standards
4. Readability - Verify content is appropriate for target audience
5. Consistency - Check terminology and formatting consistency

Continuous Quality

• Set up automated checks in CI/CD pipeline
• Regular link validation schedules
• Style guide enforcement
• User feedback integration

Tools Integration

Most quality assurance tools can be integrated into:

• Git Hooks - Run checks before commits
• CI/CD Pipelines - Automated quality gates
• Editor Extensions - Real-time feedback
• GitHub Actions - Automated PR checks

Best Practices

Establish Standards

• Create and maintain a style guide
• Define quality metrics and thresholds
• Document review processes
• Train team members on tools and standards

Monitor Continuously

• Regular audits of documentation quality
• Track metrics over time
• User feedback analysis
• Tool effectiveness evaluation

AI-Powered Review

For AI-powered review tools, agent skills, and prompt templates for documentation review, see our AI Review section.