docs(规约): 删除编号规范.md,生效规则并入文档规范 §7.1
用户裁定:docs/编号规范.md 在项目里已无意义,删除。 依据:该文 253 行里真正仍生效的只有两条规则(新条目一律不发编号、 人读文档存量编号继续清退)和一张存量族表;其余内容早有归属——两道 编号门禁的退役记录在 docs/门禁说明/id-check.md 与 id-check-new.md, 手工普查与恢复机器面在 scripts/archive/id_gate/README.md。留着就是 第二真相源,同一事实写在两处迟早漂移。 处理: - docs/文档规范.md 新增 §7.1「条目与编号:一律不发」,承接规则、 场景表、三条硬规矩、存量族表、已停发旧号族清单、不是编号的清单、 清理动作与「没有机器门禁兜底」四段。 - 活跃引用 62 处逐条改指 §7.1 或归档 README:AGENTS.md 2 处、 门禁说明三篇 18 处、其余文档 11 篇、代码与脚本 10 处、rename_maps 七个 record 字段、.dsh/skills 四个文件 8 处。 - 归档区 107 处去掉 docs/ 前缀当纯文本提及;编号治理历史.md 45 处 改为「原编号规范 §N」,避免被 doc-links 当自引用解析。 - 顺带修正 scripts/archive/id_gate/README.md 里仍称旧文为现行规范 的表述。 门禁:check_doc_links --all --sections-strict 220 篇全通过、无法判定 0; pre-commit 全 Passed。
This commit is contained in:
@@ -21,7 +21,8 @@
|
||||
作用域**只取 `*_Test_Guide.md`**:TC-CFG / TC-CLK / TC-WD 属主机侧单元
|
||||
测试文档(`配置文件单元测试说明.md` 等),不参与板级追溯,天然被排除。
|
||||
|
||||
**2026-10-21 B 层口径对齐**(docs/编号规范.md §8.1「口径修正记录」):主机侧单测的
|
||||
**2026-10-21 B 层口径对齐**(当时编号规范 §8.1「口径修正记录」;那篇已删除,
|
||||
现行规则 → `docs/文档规范.md` §7.1):主机侧单测的
|
||||
号改认 `test/host/<模块>/*` 为属主登记处(实测这些号在代码目录外零消费者),
|
||||
于是"文档没有"不再一律算断链。真差异收敛为三条:
|
||||
① 文档声明了、代码没有 → DOC-ONLY;
|
||||
@@ -30,7 +31,7 @@
|
||||
小写子项后缀(`TC-<模块码>-003b` 这类小写尾号)按母号算(`subitem_ok`),与编号门禁同口径。
|
||||
**批 6 再分两档**:硬件层人工用例(标题/章节含「(硬件层)」)记为 `BENCH`、文档已标未实现/待补/暂缓/已取消的记为 `NOTIMPL`,两者**单列示数**不进差异——但也不是「已覆盖」,只是「不该在这里期望代码」。
|
||||
**2026-10-21 第二次口径修正(批 5)**:变更记录行与 `[示例]`/`[计划]` 行**不参与比对**
|
||||
(冻结历史按编号规范 §8.1 不回改,旧号靠 `id_aliases.json` 解析;这条豁免另三支脚本早有,本脚本是最后缺它的一个,`DOC-ONLY` 因此 38 → 29、交集不变);被豁免的号存进 `frozen_ids`,`--verbose` 全量列出——**豁免不等于已对应**,别拿它当收敛。
|
||||
(冻结历史按当时的编号规范 §8.1 不回改,旧号靠 `id_aliases.json` 解析;这条豁免另三支脚本早有,本脚本是最后缺它的一个,`DOC-ONLY` 因此 38 → 29、交集不变);被豁免的号存进 `frozen_ids`,`--verbose` 全量列出——**豁免不等于已对应**,别拿它当收敛。
|
||||
|
||||
退出码:
|
||||
0 = 无差异;或有差异但**默认仅告警**(与 doc-links 演进路径一致)
|
||||
@@ -63,7 +64,7 @@ CODE_DIR = REPO_ROOT / "test" / "board"
|
||||
DOC_DIR = REPO_ROOT / "docs" / "测试说明"
|
||||
|
||||
# TC 编号:TC-<PFX>-<NNN>。<PFX> 允许字母数字(NET/GD5F/STO/RTC…)。
|
||||
# 2026-10-20 收编进 id-check 门禁时补的三条(docs/编号规范.md §8「顺带收编」):
|
||||
# 2026-10-20 收编进 id-check 门禁时补的三条(该规范 §8「顺带收编」,规范已删除):
|
||||
# ① 规范 §4.1 的合规形态 `TC-[A-Z]{1,4}-\d{3,4}[a-z]?`(带小写后缀,TC-NET-1502b);
|
||||
# ② 现存的大写后缀形态(TC-AI-01A [示例],§7.1 待统一小写)也要能抓出来,否则整条漏扫;
|
||||
# ③ 无模块码形态(iec104 文档里缺模块码的那批用例号,§7.2 列为孤儿)纳入比对而不是静默忽略。
|
||||
@@ -218,7 +219,7 @@ def main():
|
||||
# --verbose 有明细):BENCH = 人工台架定义,NOTIMPL = 已显式登记未实现
|
||||
doc_ids -= bench_ids | notimpl_ids
|
||||
doc_bases = {_base(i) for i in doc_ids}
|
||||
# 真差异定义(B 层口径 2026-10-21,docs/编号规范.md §8.1):
|
||||
# 真差异定义(B 层口径 2026-10-21,当时的编号规范 §8.1):
|
||||
# ① 文档声明了、代码里没有 → 未实现/未标注(保留,这是硬断链);
|
||||
# ② 代码有、文档没有,**且**母号也不在文档、**且**号旁边没写意图 → 真未登记;
|
||||
# ③ 代码有、文档没有,但靠"代码即登记处"过关(旁边有意图)→ 单列统计,
|
||||
|
||||
Reference in New Issue
Block a user