Skip to main content

规格 · 术语与命名

适用范围​

约束所有功能文档的公共词汇:docs/capabilities/** 各功能页,以及 docs/specifications/**、docs/standards/**、docs/guides/**、docs/operations/**。

不约束:应用内面向最终用户的界面文案(受各功能的表现设计约束);实现仓的代码标识符(受各实现仓自己的命名约定约束)。

规范条款​

状态与状态轴​

  1. 必须区分「业务状态」与「执行状态」,并在文档中显式说明二者是两条独立轴。
    • 业务状态:人或业务规则对工作项的判断(阶段、评审结论、完成与否)。
    • 执行状态:一次自动化执行的进展(排队、运行中、终态)。
  2. 执行状态使用 owning 执行服务的公开合同,不在业务系统复制第二套执行状态机。
  3. 必须避免用同一个词同时指代两类状态,例如不得用「完成」既表示业务判断又表示执行成功。

执行相关词汇​

术语含义边界
自动化委托Issue 开关表示人将 Issue 交给 Symphony不表示已经运行或验收通过
Issue 状态所有 Issue 的唯一业务进度不再维护 task_status 或隐藏阶段进度
Tracker调用平台 API 并返回统一候选任务的接入模块不负责另建调度器
领取Symphony 选中候选 Issue 并启动其执行不等于读取全部 Issue
执行状态官方 Symphony 当前执行与重试事实不从业务状态、评论或 Git 推断
业务按钮有权限、证据及版本检查的业务命令不是客户端任意状态赋值
执行身份实际调用业务操作的 Agent 或服务身份不冒充业务负责人或人类验收者

DSH 与旧编排​

旧 Plane Run、Coordinator、Worker Action、claim/get/finish 和 callback 已退出当前 Automation 合同。历史术语只用于引用其固定版本和归档证据,不得据此启动旧服务。DSH 本身及不相关工具仍由各自功能管理。

当前执行边界见 Automation 系统设计。

权属词汇​

  1. 必须使用「事实源 / owner」表达权属,且必须指明唯一持有方;必须不使用「双方共同拥有」「以 A 为准但 B 也可写」这类表达。
  2. 「truth owner」必须与其英文对应词保持同义,不得用来表示"主要负责人"。
  3. 必须为每个可变对象指明唯一 writer;多个 writer 时必须显式声明并发保护方式(修订号或等价机制)。

数据与一致性词汇​

术语唯一含义必须不用于
修订单调递增的整数,用于并发保护与顺序判定泛指任何编号
幂等身份同一逻辑命令保持稳定的标识,用于跨进程安全重放判定泛指任何 ID
重放同幂等身份与同规范化请求体再次提交泛指重试
只追加记录写入后不可改写、不可删除泛指"通常不改"
不可改写字段或记录一经写入即拒绝任何更新同上
收敛把不一致状态推进到确定的终态泛指"变好了"

边界与投影词汇​

术语唯一含义必须不用于
公开投影对外(含界面、外部系统)可见的派生视图泛指任何返回值
脱敏移除或替换敏感值后才可对外泛指"少返回字段"
内部标识符只用于系统内部关联、不得出现在公开投影或文档正文的名称泛指任何变量名
约定岗位或部门之间交付什么、对不齐时怎么失败泛指实现细节
规格全平台强制约束,见规格索引泛指任何文档

文档层词汇​

  1. 必须按下列唯一含义使用文档层词,必须不互相替代:
词唯一含义
PRD / 策划顶层文档:要达成什么、边界在哪、什么必须成立
设计文档系统怎么保证 PRD 的承诺成立(表现 / 行为 / 数据 / 接口 / 约定)
实施计划怎么一步步做到、什么时候算做到、证据指针
规格跨功能强制约束
标准评审与验证流程
指南怎么做(操作顺序)
运行文档怎么运维
  1. 必须避免自造同义词:同一概念在全平台只保留一个词;新词必须先加入本规格再使用。

命名形式​

  1. 文档中的跨功能术语必须在首次出现处给出定义或指向本规格。
  2. 页面 sidebar_label 必须与导航登记一致(由既有生成器强制)。

违反时的失败语义​

违反情形必须的行为
使用未登记的公共词汇视为规格违反;评审阶段必须拦截,不得合入
同一概念在同一功能内出现两个词视为规格违反;必须删去其中一个
权属表达含糊(共同拥有、以 A 为准但 B 可写)视为规格违反;必须补出唯一 owner
用业务状态词指代执行状态(或反之)视为规格违反;必须按状态轴拆开

校验方式​

校验对象判据失败表现
执行状态取值文档中的执行状态必须能定位到 owning 执行服务合同出现集合外取值即失败
权属表达每个可变对象必须能定位到唯一 owner 表述出现含糊表述即失败
自造同义词禁用词表(同一概念的非规范写法)不得出现命中即失败
规格模板本文件必须含本规格规定的全部小节缺节即失败

校验脚本:node scripts/validate_specs.mjs(结构部分);禁用词表与状态取值由后续增补的词表校验覆盖。

相关规格​