42 lines
1.2 KiB
Markdown
42 lines
1.2 KiB
Markdown
# 领域文档
|
|
|
|
本文件说明工程技能在分析和修改仓库前，应如何读取领域文档。
|
|
|
|
## 开始分析前
|
|
|
|
按需读取：
|
|
|
|
- 根目录的 `CONTEXT.md`
|
|
- 如果将来出现 `CONTEXT-MAP.md`，由它定位当前主题对应的领域上下文
|
|
- `docs/adr/` 中与当前修改相关的架构决策记录
|
|
|
|
文件不存在时静默继续，不需要预先创建空文件。领域词汇和架构决策应在实际形成结论时按需补充。
|
|
|
|
## 当前布局
|
|
|
|
本仓库采用单上下文结构：
|
|
|
|
```text
|
|
/
|
|
├── CONTEXT.md
|
|
└── docs/
|
|
└── adr/
|
|
```
|
|
|
|
`CONTEXT.md` 只保存领域术语和统一语言；`docs/adr/` 保存具有长期影响的架构决策。
|
|
|
|
## 使用统一领域语言
|
|
|
|
Issue 标题、规格、重构建议、测试名称和实现说明应使用 `CONTEXT.md` 中定义的术语，不应改用其中明确要求避免的同义词。
|
|
|
|
如果需要使用的概念尚未出现在词汇表中，应先判断：
|
|
|
|
1. 是否正在引入项目并不存在的新术语；
|
|
2. 是否确实发现领域词汇缺口。
|
|
|
|
真实的领域词汇缺口应通过领域建模流程补充。
|
|
|
|
## 发现 ADR 冲突时
|
|
|
|
如果计划或实现与现有 ADR 冲突，必须明确指出冲突及理由，不得静默覆盖既有决策。
|