Audits documentation for code example accuracy, API consistency, and objective technical language.
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.
Key Features
013 GitHub stars
02Subjective and marketing language detection for objective tone
03Import path and API signature verification
04Cross-referencing with actual code symbols via MCP tools
05Standardized audit reporting with severity-based issue tracking
06Automated code example validation against live implementation
Use Cases
01Enforcing objective, factual language standards across a documentation suite
02Reviewing technical documentation before a major software release
03Validating code snippets in Sphinx tutorials against recent API changes
