mcpField
D
domain-modeling

domain-modeling

github.com/vinvcnDevelopment5.4k4.3k installsUpdated 1d ago
Repository

About domain-modeling

domain-modeling is a skill for building and refining a project's domain model during design, for teams that need precise business concepts and boundaries. It clarifies concepts through terminology challenges, concrete scenarios, and code checks, while recording glossary terms and justified ADRs as they emerge.

Key features

  1. 01Challenges and aligns domain terminology
  2. 02Tests concept boundaries with concrete scenarios
  3. 03Cross-checks domain descriptions against code
  4. 04Updates GLOSSARY.md as terms are resolved
  5. 05Proposes ADRs only for hard-to-reverse trade-offs

Use cases

  1. 01Resolving ambiguity in domain terminology
  2. 02Testing edge cases between business concepts
  3. 03Finding conflicts between domain descriptions and code

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/vinvcn/mattpocock-skills-zh-cn --skill domain-modeling

After installing, type/domain-modelingin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

ADR-FORMAT.md
GLOSSARY-FORMAT.md
agents/
openai.yaml

Details

From the project README

领域建模

在设计过程中主动构建并打磨项目的 domain model。这是 active discipline:挑战术语、发明 edge-case scenarios,并在概念成形的当下写入 glossary 和 decisions。

文件结构

多数 repos 只有一个 context:

/
|- GLOSSARY.md
|- docs/
|  `- adr/
|     |- 0001-event-sourced-orders.md
|     `- 0002-postgres-for-write-model.md
`- src/

如果 root 有 GLOSSARY-MAP.md,说明 repo 有多个 contexts。map 指向每个 context 的位置:

/
|- GLOSSARY-MAP.md
|- docs/
|  `- adr/                          -> system-wide decisions
`- src/
   |- ordering/
   |  |- GLOSSARY.md
   |  `- docs/adr/                  -> context-specific decisions
   `- billing/
      |- GLOSSARY.md
      `- docs/adr/

按需懒创建文件:只有在有内容要写时才创建。如果没有 GLOSSARY.md,当第一个 term 被解决时创建它。如果没有 docs/adr/,当第一个 ADR 需要出现时创建它。

Session 期间

对照术语表质询

当用户使用的术语与 GLOSSARY.md 中既有语言冲突时,立即指出。"Your glossary defines 'cancellation' as X, but you seem to mean Y - which is it?"

打磨模糊用语

当用户使用模糊或过载术语时,提出一个精确的 canonical term。"You're saying 'account' - do you mean the Customer or the User? Those are different things."

讨论具体场景

讨论 domain relationships 时,用具体场景做压力测试。发明能探测 edge cases 的场景,迫使用户精确定义概念之间的 boundaries。

与代码交叉对照

当用户描述某事如何工作时,检查代码是否同意。如果发现矛盾,要指出:"Your code cancels entire Orders, but you just said partial cancellation is possible - which is right?"

就地更新 GLOSSARY.md

当一个 term 被解决时,立刻更新 GLOSSARY.md。不要批量攒到最后;随着概念出现就捕获。使用 GLOSSARY-FORMAT.md 中的格式。

GLOSSARY.md 必须完全不包含 implementation details。不要把 GLOSSARY.md 当 spec、scratch pad 或 implementation decisions 的仓库。它只是一份 glossary。

谨慎提议 ADR

只有以下三项都成立时,才提出创建 ADR:

  1. Hard to reverse - 之后改变主意的成本有意义
  2. Surprising without context - 未来读者会疑惑 "why did they do it this way?"
  3. The result of a real trade-off - 确实存在替代方案,而你基于具体理由选择了其中一个

缺少任一项就跳过 ADR。使用 ADR-FORMAT.md 中的格式。

Comments

Markdown supported