菜单
Write or repair code-adjacent API documentation and the matching README or ADR updates that belong with a public interface change.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
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.