Our review
Syncs documentation with code changes to keep docs accurate and current.
Strengths
- Automates updates to README, CHANGELOG, and API documentation.
- Leverages built-in scripts for journaling and status tracking.
- Verifies accuracy of code examples and hyperlinks.
Limitations
- Requires file access and Git context to detect changes.
- Does not update screenshots automatically; manual intervention needed.
Use this skill after completing feature work or when instructed to update documentation.
Do not use for code changes or for reading documentation without updating it.
Security analysis
SafeThe skill only uses safe built-in tools (Read, Write, Edit, Glob, Grep) and suggests standard git and shell commands for documentation updates. No destructive, exfiltrating, or obfuscated actions are present.
No concerns found
Examples
Update the docs for the new auth featureAdd installation instructions to READMEname: updating-documentation description: > Update documentation and README files after feature work. Use when user says "update docs", "write readme", "document this", "add docs", "update documentation", or after completing a feature that needs doc updates. Do NOT use for: code changes (use implementing-features), reading docs for understanding (use exploring-codebase). compatibility: "Requires Claude Code with file access." allowed-tools: [Read, Write, Edit, Glob, Grep] metadata: author: agentic-framework version: "0.38.0"
Updating Documentation
Sync documentation with code changes to keep docs accurate and current.
Instructions
Step 1: Identify What Changed
Check what code was modified:
git diff --stat HEAD~1
Determine which docs need updating based on the changes.
Step 2: Update Relevant Docs
Common documentation updates:
- README.md: New features, changed setup steps, updated examples
- CHANGELOG.md: Entry for the version with what changed
- API docs: New endpoints, changed parameters, updated responses
- Configuration docs: New settings, changed defaults
- Architecture docs: Structural changes, new components
Step 3: Verify Accuracy
- Code examples in docs should be runnable
- Links should point to existing files
- Version numbers should be current
- Screenshots should reflect current UI (if applicable)
Step 4: Use Framework Scripts
For framework-managed docs:
bash .agentic/tools/journal.sh "Topic" "Done" "Next" "Blockers"
bash .agentic/tools/status.sh focus "Current state"
Examples
Example 1: Post-feature documentation User says: "Update the docs for the new auth feature" Steps taken:
- Read the auth feature code to understand what was added
- Update README.md with new auth section
- Add CHANGELOG entry: "Added JWT authentication"
- Update API docs with new auth endpoints Result: Documentation matches the implemented feature.
Example 2: Quick README update User says: "Add installation instructions to README" Steps taken:
- Read existing README structure
- Check package.json/setup.py for install commands
- Write installation section with prerequisites and steps Result: Clear installation instructions added to README.
Troubleshooting
Docs out of sync with code
Cause: Code changed without doc updates.
Solution: Run git log --oneline to find recent changes, then update docs for each relevant change.
API Documentation Generator
Documentation
Automatically generates OpenAPI/Swagger API documentation.
Technical Writer
Documentation
Writes clear technical documentation following top style guides.
Pivot Decision Framework
Documentation
Documents a strategic pivot or persevere decision with evidence, analysis, and rationale. Use when evaluating whether to change direction on a product, feature, or strategy based on market feedback.