用途:在 API 变更后查找并修复仓库中过时的文档。
主要能力:通过 git diff 识别改动的 Python 文件,提取函数/方法签名、类名与 init 签名、模块级常量与类型别名、被移除或重命名的公共符号等新旧对照,再生成 docs-updater 子代理在整个仓库中传播更新。
使用方式(按原文步骤):调用 /update-docs 后立即执行。步骤 1 运行 git diff --name-only main...HEAD -- '.py',若相对 main 无改动则回退到 git diff --name-only HEAD~1 -- '.py',仍失败则询问用户改动文件;步骤 2 对每个改动文件用同一 ref 比对签名,如 git diff main...HEAD -- <file> 或 git diff HEAD~1 -- <file>;步骤 3 用 Task 工具启动子代理,subagent_type 为 general-purpose,description 字段必须包含 docs-updater 以便 SubagentStop 钩子触发,并读取 .claude/agents/docs-updater.md 获取完整指令;步骤 4 审查结果,确认未改动测试文件、变更最小且正确,并向用户汇报。若未检测到 API 变更(仅内部逻辑变化),输出“No API changes detected — no docs update needed”并停止。
适用场景:/implement 后 API 签名变化、/pre-submit-pr 前、重构公共 API 时。工作流位置:/write-tests → /implement → /update-docs → /simplify(可选)→ /pre-submit-pr。
限制:不适用于仅内部变化、仅测试变化或仅文档变化的场景。其余配置与实际运行环境细节暂未提供。