/cdocs — Update Project Documentation
Keep project documentation current after a feature lands — README, AGENT_CONTEXT.md, feature docs, and ARCHITECTURE.md suggestions.
When to Use
- After
/cverifypasses — this is the final step before merging - When the workflow state is
verifiedand the verification report exists - Not for: writing specs (use
/cspec), writing code documentation inline, or documenting features that haven’t been verified yet
How It Fits in the Workflow
/cdocs is the last skill in the pipeline before merge. The full flow is: /cspec → /creview → /ctdd → /cverify → /cdocs → merge. It requires the verification report from /cverify to exist — if it does not, the skill stops and tells you to run /cverify first.
What It Does
- Analyzes what changed — diffs against main to identify new features, changed behavior, new config options, API endpoints, environment variables, and removed functionality
- Updates README.md — checks feature list, setup instructions, usage examples, and project description against the current state of the project
- Updates AGENT_CONTEXT.md — the briefing document every fresh agent reads. Adds new components, design patterns, common pitfalls, and verifies the quick reference commands are accurate. Keeps it under 1500 words.
- Creates feature documentation — for significant features, creates or updates docs in
docs/features/with usage, configuration, examples, and known limitations - Maintains ARCHITECTURE.md entries — before suggesting new entries, checks whether existing entries need updating. Performs existing-entry staleness detection using the verification report’s Architecture Adherence section (or its own analysis if no report exists). Stale entries are presented one at a time with options to update, skip, or log as drift debt. Also surfaces open drift-debt items from
.correctless/meta/drift-debt.jsonfor resolution (resolve now, keep as debt, or close). Then suggests new entries for patterns or conventions introduced by the feature - Fact-checks against code — verifies that documented API parameters, config defaults, and described flows actually match the implementation
- Flags stale docs — checks existing documentation for references to code, config, or features that no longer exist
Example
Agent: Diff analysis complete — 1 new feature (login rate limiting),
2 new config options. Checking README...
README changes proposed:
- Add "Rate Limiting" to the Features section
- Add RATE_LIMIT_WINDOW_MINUTES to the Configuration table
AGENT_CONTEXT.md updates:
- Add Redis dependency to Key Components
- Add rate limiting pattern to Design Patterns
Feature doc: created docs/features/rate-limiting.md
- What it does, config options, Redis requirement
ARCHITECTURE.md: no new patterns needed — rate limiting
follows existing middleware pattern (PAT-003).
Staleness check: docs/features/old-auth.md references
`src/middleware/basicAuth.ts` which was removed in this branch.
Approve these changes?
What It Reads / Writes
| Reads | Writes |
|---|---|
docs/verification/{slug}-verification.md | README.md (updated) |
.correctless/specs/{slug}.md | AGENT_CONTEXT.md (updated) |
README.md, ARCHITECTURE.md, AGENT_CONTEXT.md | docs/features/{slug}.md (new or updated) |
.correctless/config/workflow-config.json | ARCHITECTURE.md (additions, if approved) |
| Git diff against main | CLAUDE.md (convention learning, if 3+ features share a pattern) |
| Workflow state (advances to documented) |
Intensity Levels
Same at all intensity levels for documentation checks. At high/critical intensity, convention learning is included — if the same architectural pattern has appeared in 3+ features, it appends a “Convention confirmed” entry to CLAUDE.md so future agents treat it as an established project convention.
Common Issues
- “Run /cverify first”: The skill requires the verification report at
docs/verification/{slug}-verification.md. If you see this message, run/cverifybefore/cdocs. - AGENT_CONTEXT.md too long: The skill enforces a 1500-word limit. If your project context is growing, it will trim and prioritize. Reference ARCHITECTURE.md for details rather than duplicating content.