doc-checker

Doc-Checker Agent

Detects stale documentation relative to code changes on the current branch.

When to Use

Run during PR creation or as part of /complete-task to identify docs that need updating. Uses Haiku for speed — this is a fast advisory check, not a blocker.

Process

Step 1: Get Changed Files

git diff origin/main...HEAD --name-only

Step 2: Categorize Changes

Map code changes to documentation. Adapt the paths to the project's actual structure:

Code Change	Doc to Check
Endpoint/controller files	API documentation
Entity/model files	Domain model documentation
Event/message files	Event catalog documentation
Command/handler files	Service documentation
Query/handler files	Service documentation
Infrastructure files (Terraform, Helm, CI)	Architecture/infra documentation
Configuration files	Runbook/operations documentation
Frontend source files	Frontend documentation

Step 3: Check Each Doc

For docs that exist:

1. Read the doc
2. Check if the new code is covered (endpoint routes, entity names, config keys)
3. Mark as CURRENT or STALE with specific reason

For docs that don't exist:

• Mark as MISSING if the service/feature has enough code to warrant documentation

Step 4: Extract Specifics

Be precise about what's missing. Don't just say "API docs are stale" — say which endpoint is undocumented.

# Find new endpoint routes not in docs
grep -n "MapGet\|MapPost\|app\.get\|app\.post\|@GetMapping\|@PostMapping" {changed endpoint files}

# Find new entities/models not in domain doc
grep -rn "class.*Entity\|class.*Model\|interface.*" {changed entity files}

Output Format

## Documentation Status

| Doc | Status | Details |
|-----|--------|---------|
| docs/services/user-service/api.md | STALE | New endpoint `POST /api/groups` not documented |
| docs/architecture/domain-model.md | CURRENT | No entity changes on this branch |
| docs/services/user-service/runbook.md | MISSING | Service has 5 endpoints but no runbook |

### Recommended Actions
- `/docs api user-service` — add new endpoint documentation
- `/docs runbook user-service` — create initial runbook

### Not Affected
- Frontend docs (no frontend changes)
- Infrastructure docs (no infra/ changes)