Skip to content

robertlong13/docs-auditor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Docs Auditor

A Claude Code workflow that audits your GitHub repos for stale documentation.

As much as I try to keep up with my lovingly-written .md files in my repos, I frequently forget. Often it's a simple matter that I've forgotten I even documented some aspect of my code in the first place. This tool goes through all your recent activity and flags any documentation drift you may have introduced.

This is a partially manual process, by design.

Why not a bot?

There's no infrastructure to set up—no API keys, no CI jobs, no webhooks. Open Claude Code, say "let's go," and you're auditing. Easy to make a weekly or monthly habit of.

And most doc staleness isn't mechanical enough for a bot to fix well on its own. Deciding whether to fix the wording, rewrite the section, or cut it entirely is an editorial call. There will always be a review process and back/forth; that might as well happen when you sit down periodically to audit all your docs.

What it does

  • Initial audit — Reads every doc in a repo, verifies it against the code, and opens PRs to fix what's wrong. One repo per session, done thoroughly.
  • Weekly checks — After a repo's been audited, diffs since last time are scanned for changes that might have made docs stale. Quick and focused.

Prerequisites

Getting Started

Clone this repo, open it in Claude Code, and say "Let's go." Claude handles the rest — it'll walk you through setup, find your repos, and start auditing.

About

Keep your damn docs up to date

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published