documenting-code
Installation
SKILL.md
Documentation Update
Scope: documentation files only. Not for session-learning extraction (use learning-patterns) or code-quality review (use reviewing-code).
Update project documentation to reflect current code state. Do not delete or overwrite existing docs without confirmation. If verification fails or required evidence is unavailable, report the failure instead of claiming docs are current.
Roles
Detect your capability from your tools, not from prose:
- Write-capable role (engineer): run the 4-phase flow below — apply the doc edits and verify.
- Read-only role (reviewer): do not run the phases. You have no edit or Bash tools (no
git diff). Work from the changed-file list the caller supplies, read the relevant code and existing docs, then emit the stale or missing docs as a proposal in the Reviewer Output contract at the end. Apply nothing; run nothing.
Use TaskCreate / TaskUpdate to track these 4 phases:
- Determine documentation scope
- Analyze recent changes
- Analyze and update documentation
- Verify and report