Connect

README & Documentation Auditor

Claude-AI-Tools-Ventura-CountybyClaude-AI-Tools-Ventura-County
0•
Learning & Documentation

Audits project README files and linked documentation graphs to detect drift, dead links, contradictions, and operator UX gaps.

The README & Documentation Auditor skill performs a rigorous, operator-focused inspection of a repository's root README and its outbound link graph. Treating the README as both a critical onboarding artifact and a blueprint of the codebase, it verifies concrete claims against actual project files, validates relative links and anchors, resolves contradictions between linked documents, and flags structural UX issues. It provides an actionable scorecard highlighting drift, broken commands, and orphaned documentation, with an optional automated pass to safely resolve deterministic fixes like broken links and outdated counts.

Key Features

01Evaluates first-screen orientation and operator UX for core user workflows
020 GitHub stars
03Identifies contradictions and discrepancies between README and secondary documentation
04Validates complete link graphs including relative files, heading anchors, and badges
05Offers safe, one-click automated remediation for mechanical doc issues like dead links and stale counts
06Verifies code claims, commands, flags, and file paths against actual repository state

Use Cases

01Assessing open-source repos to ensure new contributors and operators can successfully onboard
02Auditing repository documentation before major open-source releases or public launches
03Preventing documentation drift and broken links after major refactors or file restructurings