documenting-code

Installation
SKILL.md

Documentation Update

Update project documentation to reflect current code state.

Use TaskCreate / TaskUpdate to track these 5 phases:

  1. Determine documentation scope
  2. Analyze recent changes
  3. Spawn docs-keeper agent
  4. Update documentation
  5. 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: Verify and Present Summary

Independent verification (do not trust the agent's self-report):

  1. Run git diff --stat to confirm files were actually changed
  2. For each changed file, verify the diff looks correct (no broken links, no placeholder text)
  3. If no files changed, report that docs-keeper made no modifications

Report what was updated, verified diffs, and any issues found.

If no recent changes are found or documentation scope is unclear, ask the user what to document rather than generating speculative documentation.

Execute documentation update now.

Related skills
Installs
3
GitHub Stars
19
First Seen
Apr 14, 2026