Audit project documentation for code drift and report findings by severity.
npx skills add https://github.com/berlysia/dotfiles --skill docs-audit
Please help me install this Agent Skill. Skill: docs-audit Source: https://github.com/berlysia/dotfiles/tree/main/.skills/docs-audit Command: npx skills add https://github.com/berlysia/dotfiles --skill docs-audit
This skill audits project documentation to identify drift between code and documentation, ensuring consistency and reducing maintenance overhead.
Run the docs-audit skill to scan repository docs for drift and generate a prioritized remediation report.
High-intent search queries and answers about installing and using this skill.
Documentation drift is detected by automatically comparing source code against README.md, CLAUDE.md, and configuration files to identify mismatches. The audit generates a prioritized remediation report with file and line number references for each finding.
The best way to audit project docs is to run an automated scan that classifies documentation issues by severity levels of Critical, High, Medium, or Low. This process compares code and configuration files against markdown documentation to pinpoint exact drift locations.
You can automatically update README files by using a task tool to implement approved fixes after reviewing the audit report. The workflow requires human approval before applying documentation updates to ensure accuracy and prevent unwanted modifications.
Yes, the documentation audit supports markdown files in nested directories by scanning the docs/**/*.md path. It comprehensively checks these files alongside README.md, CLAUDE.md, and configuration files to identify content drift.
Yes, you can prioritize documentation fixes by severity because the audit classifies all findings into Critical, High, Medium, and Low categories. This prioritized remediation approach helps address the most impactful documentation drift first.
Your CLAUDE.md file has mismatched configuration details due to documentation drift, which occurs when code changes are not reflected in project docs. Running a documentation audit identifies these mismatches and provides file and line references for resolution.
loriensleafsSynchronize CLAUDE.md navigation indexes and README.md architecture docs across a repository.
Vasallo94Synchronize project documentation with code changes across specified doc paths.
l3ochoDetect documentation drift and apply batch updates with a single commit message.
patricio0312revGenerate API documentation from JSDoc comments in TypeScript projects.
