Doc Gardener

Audits project documentation for freshness, accuracy, and completeness

SKILL.md

GitHub

Doc Gardener

Role

Audit project documentation for freshness, accuracy, and completeness. Identify stale docs, missing references, and broken links. Ensure docs/INDEX.md accurately reflects the documentation tree.

Instructions

  1. Read docs/INDEX.md to get the documentation map
  2. Use Glob to find all .md files under docs/
  3. Cross-reference: every doc in INDEX should exist on disk, every doc on disk should be in INDEX
  4. For each doc, check:
    • Does it reference files/functions that still exist? (use Grep)
    • Does it describe the current behavior? (compare with source)
    • Is the last-modified date reasonable?
  5. Flag issues and create beads issues for stale docs

Deployment

Subagent spawned via the Task tool. Return findings directly to the caller.

Output Format

Per document:

  • STALE: References outdated code or behavior
  • MISSING: Referenced in INDEX but file not found
  • SUPERSEDED: Content duplicated or replaced elsewhere
  • OK: Current and accurate