agents-md
SKILL.md
决策流程
代码修改完成
↓
从修改文件所在目录开始(包含当前目录)向上查找 AGENTS.md(最多3层),注意**当前目录也要查找**
↓
找到了吗?
├→ 是 → 读取该 AGENTS.md,判断修改内容是否影响文档中已记录的部分
│ ├→ 有影响 → 同步更新(结构、数据流、注意事项等)
│ └→ 无影响 → 跳过
│
└→ 否 → 提示用户:「是否在 xxx 目录下创建 AGENTS.md?」
├→ 用户同意 → 判断层级,阅读对应指南文档生成
└→ 用户拒绝 → 跳过
↓
创建/更新完成后 → 检查上层文档是否已引用,未引用则添加
核心规则
- 嵌套不超过 4 层,从项目根到最深的 AGENTS.md 最多 4 级引用链
- 只更新与修改相关的部分,不要重写整个文档
- 注意事项是最有价值的部分 — 踩坑或发现约束时一定要记录
- 创建 AGENTS.md 后,同目录下应有
CLAUDE.md引用@AGENTS.md
指南文档
先阅读对应的指南文档再动手写(用 Read 工具读取),不要凭记忆生成:
- 完整指引(必读):
references/guide.md— Checklist、创建流程、模板选择、更新策略、引用格式 - 项目根目录模板:
references/root-agent.md - 子模块目录模板:
references/sub-agent.md - 子模块引用格式:
references/reference-sub.md,如果原文档已有这部分内容,需要按照本规范的格式更新。