name: Documentation Sync
description: Check that documentation matches the current code
category: audit

guidelines:
  - CLAUDE.md is the primary developer reference — it must be accurate
  - README.md should match the current API surface
  - Code comments should match actual behaviour
  - Examples in docs should compile and run

phases:
  - name: CLAUDE.md Audit
    description: Verify CLAUDE.md matches the codebase
    tasks:
      - "Check listed commands still work"
      - "Check architecture description matches current package structure"
      - "Check coding standards section matches actual conventions used"
      - "Check dependency list is current"
      - "Flag outdated sections"

  - name: API Documentation
    description: Check inline docs match behaviour
    tasks:
      - "Check all exported functions have doc comments"
      - "Check doc comments describe current behaviour (not historical)"
      - "Check parameter descriptions are accurate"
      - "Check return value descriptions match actual returns"

  - name: Example Validation
    description: Verify examples are correct
    tasks:
      - "Check code examples in docs use current API signatures"
      - "Check import paths are correct"
      - "Flag examples that reference removed or renamed functions"

  - name: Report
    description: Document findings
    tasks:
      - "List each outdated doc with file, section, and what needs updating"
      - "Classify as stale (wrong info) vs missing (no docs for new code)"
