docs(acm2-75): 精简不变量与声明边界,去掉无依据条目
审改 specification 管道/航班域/投影与 CLM:作废与需求重复或依据不足的 INV/CLM,白话重写保留条款,并同步架构、实现与引用注释。 Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
+4
-4
@@ -29,7 +29,7 @@
|
||||
|---|---|---|
|
||||
| 收报扫描谓词与幂等登记 | implementation.md「收报」 | specification.md 写对库方的承诺 `C-30`;reference.md 写参数 |
|
||||
| 保留期下界 `R_keep`、清除前置条件 | specification.md「约定」 | implementation.md 只写行为约束;执行步骤在上线前另立 |
|
||||
| 处理标记(处理时间)写权限 | specification.md `C-5`、`C-15`(只写完成时刻、只填空值) | implementation.md 只写行为约束(`INV-7`) |
|
||||
| 处理标记(处理时间)写权限 | specification.md 术语「处理标记」;`US-10` | implementation.md「回填」(只填空值、不覆盖) |
|
||||
| 回填四结果、放弃语义、`R` 的作用 | implementation.md「回填」 | specification.md 记结论与可声明性 |
|
||||
| 退避 / `claim-batch` / 回填期限等取值 | reference.md「参数」 | 其余文档只引 `PARAM:<key>` |
|
||||
| 消费权排他、ID 不复位、报文不可变、时钟、单实例 | specification.md「前提」 | 其他文档只引 `PRE-x` |
|
||||
@@ -48,10 +48,10 @@
|
||||
- `C-x`、`INV-x` 用加粗定义行(`- **C-5** …`);
|
||||
- `CLM-n`、`OPS-n`、`Dn`、`PRE-n`、`Qn`、`G-NAME` 与 `PARAM:<key>` 用注册表首列;首列必须是**单个裸 ID**
|
||||
(`` `ID` `` 或 `ID`)。成组登记(`` `a` / `b` ``)、带括注的首列与写成 `` `ID` `` 的引用行都不算定义。
|
||||
- 同一行登记多个 ID(如验证映射的 `INV-20b / CLM-3`)是引用行,不构成定义。
|
||||
- 同一行登记多个 ID(如验证映射的 `INV-17b`、`INV-23`)是引用行,不构成定义。
|
||||
其他位置一律是引用。
|
||||
- 编号稳定:条款被取代时标 `[作废 by C-y]` 并保留原文;不静默改写,不重编号。
|
||||
- **引用只用稳定 ID**,不用章节号:写 `INV-3`、`C-8`、`PARAM:msgx.pipeline.claim-batch`,或「见 implementation.md『收报』」这类文件名 + 小节名指针。章节号随增删章节腐烂,指针失效后必然被改写为复述。
|
||||
- **引用只用稳定 ID**,不用章节号:写 `US-03` AC1、`C-8`、`PARAM:msgx.pipeline.claim-batch`,或「见 implementation.md『收报』」这类文件名 + 小节名指针。章节号随增删章节腐烂,指针失效后必然被改写为复述。
|
||||
- 指针之后**不再复述**被指内容。若两处需要同一段话,说明它放错了位置。
|
||||
- 外部 SIS 证据统一写 `SIS:<section>`(如 `SIS:3.16-note-4`),解析到 [legacy/SIS_AODB_RMS-V0.1.md](legacy/SIS_AODB_RMS-V0.1.md) 的章节;它不属于本项目规范 ID,不参与唯一定义检查。
|
||||
- `G-NAME` 是活跃偏差 ID:定义只在 specification.md「当前已知偏差」注册表,其他位置只写标记;偏差闭合时在同一变更中删除定义与全仓引用,历史与关闭证据只留 Plane。
|
||||
@@ -75,5 +75,5 @@
|
||||
## 6. 不建的文件
|
||||
|
||||
- 顶层不再增加 Markdown:`docs/` 顶层固定为上述 6 个文件加允许的专题目录。
|
||||
- 不建运行规程文件:设计阶段没有可执行的运行环境,操作步骤在上线/切流前另立(`docs/runbooks/*.md`);设计阶段需要的只有前置条件与红线,它们分别在 specification.md(`C-7`–`C-12`)与 specification.md 的 `CLM-x`。
|
||||
- 不建运行规程文件:设计阶段没有可执行的运行环境,操作步骤在上线/切流前另立(`docs/runbooks/*.md`);设计阶段需要的只有前置条件与红线,它们分别在 specification.md(`C-1`、`C-12`)与 specification.md 的 `CLM-x`。
|
||||
- 声明边界与 Plane 分离:未交付、未确认、不可声明的主张记在 specification.md,逐项处置在 Plane(ACM2),不在正文逐段标注。
|
||||
|
||||
Reference in New Issue
Block a user