documenting-code
Documentation Update
Update project documentation to reflect current code state.
Use TodoWrite to track these 5 phases:
- Determine documentation scope
- Analyze recent changes
- Spawn docs-keeper agent
- Update documentation
- Verify and report
Phase 1: Determine Scope
Use AskUserQuestion:
| Header | Question | Options |
|---|---|---|
| Doc scope | What documentation should I update? | 1. Auto-detect - Scan for outdated docs based on recent changes 2. README - Update project README 3. API docs - Update API/function documentation 4. All - Comprehensive documentation refresh |
Phase 2-4: Spawn docs-keeper Agent
Spawn docs-keeper agent with documentation prompt:
Task with docs-keeper agent:
"Update documentation for this project.
## Your Task
1. Analyze current state:
- Run `git diff --name-only HEAD~5` for recent changes
- Find existing docs: `find . -name '*.md' -o -name 'doc.go'`
- Check project structure and dependencies
2. Scope: {user's choice from Step 1}
3. Update focus:
- Accurate function/method documentation
- README sections matching current state
- API endpoint documentation
- Architecture notes if significant changes
4. Verify:
- No broken links
- Code examples compile/run
- Markdown renders correctly
## Output Format
DOCUMENTATION UPDATE
====================
Updated:
- file.md (what changed)
- pkg/doc.go (added GoDoc)
Verified: All links valid, examples compile"
Phase 4: Research Best Practices (If Needed)
Use Context7 for documentation patterns:
mcp__context7__query-docs for GoDoc, Sphinx, or framework-specific docs
Phase 5: Present Summary
Report what was updated and verified.
Execute documentation update now.
More from alexei-led/claude-code-config
brainstorming-ideas
Turn ideas into designs through collaborative dialogue. Use when user wants to brainstorm, design features, explore approaches, or think through implementation before coding.
19refactoring-code
Batch refactoring via MorphLLM edit_file. Use for "refactor across files", "batch rename", "update pattern everywhere", large files (500+ lines), or 5+ edits in same file.
11testing-e2e
E2E testing with Playwright MCP for browser automation, test generation, and UI testing. Use when discussing E2E tests, Playwright, browser testing, UI automation, visual testing, or accessibility testing. Supports TypeScript tests and Go/HTMX web applications.
10writing-python
Idiomatic Python 3.14+ development. Use when writing Python code, CLI tools, scripts, or services. Emphasizes stdlib, type hints, uv/ruff toolchain, and minimal dependencies.
7looking-up-docs
Library documentation via Context7. Use for API references, code examples, framework docs.
7writing-typescript
Idiomatic TypeScript development. Use when writing TypeScript code, Node.js services, React apps, or discussing TS patterns. Emphasizes strict typing, composition, and modern tooling (bun/vite).
7