Documentation Audit & Validation

关于

The Documentation Audit skill empowers developers to maintain high-quality technical documentation by validating code examples against the actual implementation. It identifies broken import paths, outdated API signatures, and missing error handling while simultaneously scanning for subjective marketing language to ensure a professional, factual tone. By leveraging MCP tools to cross-reference symbols in the codebase, it bridges the gap between implementation reality and documentation, making it an essential tool for pre-release reviews and maintaining framework standards.

主要功能

• 3 GitHub stars
• Subjective and marketing language detection for objective tone
• Import path and API signature verification
• Cross-referencing with actual code symbols via MCP tools
• Standardized audit reporting with severity-based issue tracking
• Automated code example validation against live implementation

使用场景

• Enforcing objective, factual language standards across a documentation suite
• Reviewing technical documentation before a major software release
• Validating code snippets in Sphinx tutorials against recent API changes