mirror of
https://github.com/testthedocs/awesome-docs.git
synced 2026-07-16 22:32:23 -05:00
edbcb85587
- Restructured homepage with clear category overview - Created comprehensive Site Generators page with detailed tool descriptions - Built API Documentation page covering tools, testing, and best practices - Added Quality Assurance page with linting, testing, and accessibility tools - Updated navigation with organized tool categories and resources - Enhanced sidebar with logical content grouping - Transformed flat README list into searchable, navigable documentation New structure: - Core Tools: Site Generators, API Documentation - Content & Quality: Writing Tools, Quality Assurance - Resources: Style Guides, Reading List, GitHub Actions - Getting Started: Introduction, Installation All content now properly categorized and easily discoverable through navigation and search.
3.0 KiB
3.0 KiB
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
- Grammar & Style - Run through Alex, Vale, or similar tools
- Link Validation - Check all internal and external links
- Accessibility - Ensure content meets accessibility standards
- Readability - Verify content is appropriate for target audience
- 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