doc.md

来自 cli/templates/level-3/

markdown

---
name: doc
description: >
  文档更新。代码变更后使用，确保文档与代码同步。
  检查并更新 CLAUDE.md、README、API 文档等。
---

# 文档更新

## 步骤

1. 运行 `git diff --name-only` 查看本次变更的文件列表

2. 检查以下文档是否需要更新：
   - 新增模块/目录 → CLAUDE.md "架构" 章节
   - 新增命令/脚本 → CLAUDE.md "命令" 章节
   - 新增/修改 API → README 或 API 文档
   - 新增依赖 → docs/approved-deps.md
   - 重大技术决策 → docs/adr/ 新增 ADR
   - 环境变量变更 → README 或 .env.example

3. 执行必要的更新

4. 输出更新摘要：

文档更新摘要

已更新：[列出更新的文档及改动点]
无需更新：[说明为什么不需要更新]


IMPORTANT：只更新确实需要更新的文档，不要过度补充。没有需要更新的文档就明确告知。