All checks were successful
构建并部署到测试环境(无 SSH) / build-and-deploy (push) Successful in 6m24s
1.8 KiB
1.8 KiB
领域文档
工程类 Skill(improve-codebase-architecture、diagnose、tdd 等)在探索代码库前应如何消费本仓库的领域文档。
探索前请先阅读
- 根目录的
CONTEXT.md(单 Context 布局) - 根目录的
docs/adr/—— 阅读与当前改动相关的 ADR
如果这些文件还不存在,直接跳过,不要提示缺失,也不要主动建议现在就创建它们。这两个文件由 /grill-with-docs 在术语或决定真正确定下来时按需创建。
与 openspec/ 的关系
本仓库已经使用 openspec/(openspec/specs/ 存放规范、openspec/changes/ 存放变更提案)作为正式的提案与规范工作流,详见根目录 CLAUDE.md 的「OpenSpec 工作流」一节。CONTEXT.md / docs/adr/ 是补充性质的轻量级领域词汇表和架构决定记录,不会替代 openspec 流程:
- 涉及接口/数据库等实际变更 → 走 openspec 提案
- 记录领域词汇、命名约定、历史架构权衡 → 写入
CONTEXT.md/docs/adr/
文件结构(单 Context)
/
├── CONTEXT.md
├── docs/adr/
│ ├── 0001-xxx.md
│ └── 0002-xxx.md
└── openspec/
使用词汇表中的术语
当输出内容涉及某个领域概念时(issue 标题、重构提案、假设、测试名称),使用 CONTEXT.md 中定义的术语,不要漂移到词汇表明确避免使用的同义词。
如果你需要的概念还不在词汇表中,这是一个信号——可能是你在发明项目并未使用的语言(应重新考虑),也可能是真实存在的空白(记录下来留给 /grill-with-docs)。
标记与 ADR 的冲突
如果你的输出与某条已有 ADR 冲突,必须显式指出,而不是悄悄覆盖:
与 ADR-0007(事件溯源订单)冲突——但值得重新讨论,原因是……