Documentation Audit & Accuracy
Audits project documentation against source code to identify stale content, broken links, and missing docstrings.
The Documentation Audit skill helps maintain high-quality documentation by verifying that markdown files, READMEs, and docstrings remain synchronized with your actual codebase. It identifies inaccurate code examples, detects broken internal and external links, and calculates docstring coverage across multiple languages like TypeScript, Python, Rust, and Go. By prioritizing stale files and providing structured markdown reports, it ensures your project's knowledge base stays reliable and up-to-date with minimal manual effort.
主な機能
01Deep link validation for internal markdown, anchor references, and images
02Intelligent discovery script to prioritize stale or recently changed files
03Comprehensive report generation with YAML frontmatter for traceability
0418 GitHub stars
05Automated accuracy checks for code examples and function signatures
06Multi-language docstring coverage analysis for TS, Python, Rust, and Go
ユースケース
01Identifying broken links and outdated setup instructions in large monorepos
02Auditing docstring coverage to ensure high code quality and maintainability standards
03Maintaining synchronization between API documentation and implementation during rapid development