Add doc-audit plugin: audit codebase docs for accuracy and freshness#34
Merged
Add doc-audit plugin: audit codebase docs for accuracy and freshness#34
Conversation
Generic skill that compares documentation against actual code structure. Companion to agent-ready (which scaffolds docs — doc-audit maintains them). Three modes: - audit: read-only report with findings by dimension - fix: auto-fix small issues (paths, counts, links), report big ones - full: fix + generate improvement roadmap Four assessment dimensions: completeness, accuracy, freshness, coherence. Pattern-aware for monorepo and single-package projects. Includes recon.sh for fast metadata gathering, dimension reference files for assessment criteria, and audit report template.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Generic skill that compares documentation against actual code structure. Companion to agent-ready (which scaffolds docs — doc-audit maintains them).
Three modes:
Four assessment dimensions: completeness, accuracy, freshness, coherence. Pattern-aware for monorepo and single-package projects.
Includes recon.sh for fast metadata gathering, dimension reference files for assessment criteria, and audit report template.