documenting-code
Installation
SKILL.md
Documentation Update
Scope: documentation files, agent instruction files, and useful code comments
only. Not for code-quality review; use reviewing-code for that.
Update docs from implementation facts. Identify the reader first. Apply edits only when write tools are available. If evidence or validation is missing, report the gap instead of claiming docs are current.
Tool use
- Use Read for implementation, tests, and existing docs.
- Use Edit for targeted doc changes. Use Write only for new docs or full rewrites.
- Use Bash only for status, diffs, markdown lint, docs checks, and narrow repo validation.
- Use TaskCreate only for a large documentation audit that needs a bounded read-only mapping pass. Verify the returned claims before editing.
- Use AskUserQuestion only when scope or reader is ambiguous.