SuperAPI AI 工具集

domain-language

写作与研究

查看项目

更新于 10-20 20:39

技能介绍

用途 domain-language 用于在特性访谈结束后统一该特性的领域语言,确保规格、代码、测试与界面文案对同一概念使用同一说法。其范围仅限当前特性的术语以及该特性触及的既有术语,不为整个系统建模,也不引入 DDD 结构(聚合、实体、值对象、限界上下文、仓储均不涉及)。

输入

  • .scratchpad/<slug>/interview-decisions.md 访谈决策文件。
  • 该特性涉及的代码、测试与界面文案;既有命名优先保留,除非其本身有误。
  • 项目的界面语言(例如商店界面为西班牙语和英语,后台仅英语)。

主要能力与使用方式

  1. 列出访谈决策中所有表示事物、人物、状态或动作的名词与动词。
  2. 将同义词分组,每组选定一个术语;优先采用功能用户会说的词,其次采用代码中已在使用的词。
  3. 为每个术语写一行表格:术语、一句话定义、代码标识符(表、列、类型、路由段)、各界面语言的界面文案,以及应避免使用的词。
  4. 对存在生命周期的记录,列出其状态及在状态间迁移的动作,并标注每个动作的执行者,附 stateDiagram-v2 状态图(plain-visual-docs)。
  5. 记录未解决的歧义(一词多义或概念没有名称),用推荐方案解决,或向用户询问。
  6. 对照代码检查结果:已有标识符须与当前拼写一致,并核对 URL 路径、查询参数与表单字段名,这些是后期难以更改的公开名称。

输出 结果保存为 .scratchpad/<slug>/domain-language.md,使用对话语言,代码标识符按代码中的拼写书写。write-acceptance-spec 会把表格与状态图复制到规格的 ## Domain language 段落,使语言留在仓库中。此后规格、计划、代码、测试、提交信息与界面文案只使用选定术语;评审若发现“应避免”列中的词,会报为 🟡 问题。

模板

术语 定义 代码 界面(西) 界面(英) 避免
order 客户在一次结账中购买的内容,从付款到交付或取消 orders、Order pedido order purchase、sale、cart
每个项目界面语言对应一列界面文案。

适用场景与限制 适用于需要在单一特性范围内统一术语、减少规格与实现用语不一致的场景。不用于全系统领域建模,不产出 DDD 结构;具体支持的界面语言数量与状态图渲染工具范围暂未提供。