跳转至

领域文档

工程技能在探索代码库时,应当如何使用本仓库的领域文档。

探索前,请先阅读以下内容

  • 仓库根目录下的 CONTEXT.md —— 只要它存在就应阅读。它尚未被创建,所以目前通常读取不到任何内容;见下文。
  • docs/adr/ —— 阅读涉及你即将工作的领域的 ADR。

如果这些文件中有任何不存在,静默继续。不要指出它们缺失,也不要提前建议创建它们。/domain-modeling 技能(通过 /grill-with-docs 和 /improve-codebase-architecture 访问)会在术语或决策真正得到解决时,惰性地创建这些文件。

CLAUDE.md 是当前事实上的上下文文档——它承载着项目约束、版本控制/文档同步/变更日志/修复质量规则,以及本地优先保证。请将它与本文中的任何内容一并作为上下文阅读。

文件结构

单上下文仓库(大多数仓库):

/
├── CONTEXT.md
├── docs/adr/
│   ├── 0001-event-sourced-orders.md
│   └── 0002-postgres-for-write-model.md
└── src/

多上下文仓库(根目录存在 CONTEXT-MAP.md):

/
├── CONTEXT-MAP.md
├── docs/adr/                          ← system-wide decisions
└── src/
    ├── ordering/
    │   ├── CONTEXT.md
    │   └── docs/adr/                  ← context-specific decisions
    └── billing/
        ├── CONTEXT.md
        └── docs/adr/

使用术语表中的词汇

当你的输出命名一个领域概念时(在问题标题、重构提案、假设或测试名称中),请使用 CONTEXT.md 中定义的术语。不要偏向术语表明确回避的同义词。

如果你需要的概念尚不在术语表中,那是一个信号——要么你在发明项目不使用的语言(请重新考虑),要么确实存在缺口(请为 /domain-modeling 记下它)。

标记 ADR 冲突

如果你的输出与现有 ADR 相矛盾,请明确指出,而不是静默覆盖:

与 ADR-0007(事件溯源订单)相矛盾——但值得重新讨论,因为……

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 om/VoiceStudio