Menu
Write or repair code-adjacent API documentation and the matching README or ADR updates that belong with a public interface change.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
Quick grounding at session start. Read directives, memory, check practice box, apply session priority order, then discuss with user.
Create a well-formed commit for current changes with conventional message format.
Post-work consolidation: extract docs from plans, rotate napkin, check fitness, check practice box.
Canonical homing method for moving durable content out of ephemeral surfaces.
Run quality gates and fix all issues. All failures are blocking.
Re-ground and structure execution with ACTION/REVIEW/GROUNDING cadence.
| name | tsdoc |
| classification | passive |
| description | Write or repair code-adjacent API documentation and the matching README or ADR updates that belong with a public interface change. |
The skill name is kept for cross-repo continuity. In this Python template, the equivalent surface is docstrings and adjacent API-facing documentation rather than TypeScript-specific TSDoc comments.
.agent/directives/principles.md.agent/directives/testing-strategy.md when documenting test-facing
behaviour.agent/rules/documentation-hygiene.mdDo not duplicate the same explanation across all three homes. Put the content in its canonical place and link across only when helpful.