| name | update-docs |
| description | Update inline documentation for uncommitted code changes. Use after modifying code or when documentation needs sync. |
| context | fork |
| agent | doc-updater |
Documentation Update Task
Update documentation for all uncommitted code changes.
Steps
- Run
git diff --name-only to identify modified files
- For each code file:
- Detect existing documentation style (see references/doc-patterns.md)
- Find new/modified functions, classes, methods
- Add or update documentation blocks
- If
/docs folder exists:
- Check if changed code has corresponding docs
- Update affected documentation files
- Do NOT modify README.md, CHANGELOG.md, LICENSE
- Report all changes made
Reference Documents
For documentation patterns by language, read:
references/doc-patterns.md - Format examples for each stack
Documentation Style Matching
Always match the existing documentation style in the file:
- If PHPDoc exists, use PHPDoc
- If JSDoc exists, use JSDoc
- If no existing docs, detect from file extension
Output Requirements
Return a report listing:
- Files modified
- Docblocks added/updated
- Summary counts