用途:doc-naming 是 SDD(规范驱动开发)八层流程的命名权威,横跨全部 8 层。它为文档 ID、元素 ID、@threshold 阈值标签和文件名提供校验,并对已移除或遗留的命名模式给出迁移目标。它不产出任何工件,是声明式 ID 校验器,框架本身不携带运行时代码。创建或编辑任何工件前使用;跨文档可追溯性与内容审查不属于它,应改用 doc-validator。
主要能力:文档 ID 采用 TYPE-NN 格式,如 BRD-01、ADR-99、IPLAN-102,文件名为 TYPE-NN_descriptive_slug.md。元素 ID 采用四段式 TYPE.NN.SS.xxxx,前三段为大写类型、文档号与来源章节号,末段为 4 位十六进制(碰撞时 8 位)稳定内容标识,例如 BRD.01.07.a7f3,以 markdown 标题形式出现。引用粒度按层不同:BRD、PRD、EARS、BDD、TDD 使用元素级点分引用;ADR 同时支持 ADR-NN 与元素级;SPEC、IPLAN 使用短横线文档引用。阈值标签格式为 @threshold: {TYPE}.{NN}.{key},key 为 category.subcategory.attribute[.qualifier],类别有 perf、timeout、rate、retry、circuit、alert、cache、pool、queue、batch,文档引用必填且用点分隔,如 @threshold: PRD.035.timeout.partner.bridge 有效,缺少文档引用无效。TYPE-00_* 索引、模板与术语表可跳过元素 ID 与可追溯性检查;TYPE-REF-NN_*.md 仅限 BRD/ADR 的引用目标,无元素 ID 与质量门禁。
使用方式:按预检清单核对:文档 ID 为 TYPE-NN 且文件名匹配;元素 ID 为四段式且哈希在文档内唯一,SPEC/IPLAN 用短横线文档引用;@threshold 标签含文档引用与获批类别;无已移除/遗留模式,无三段式元素 ID;可追溯标签前缀正确且目标存在。检测遗留模式可用 grep -E "(AC|FR|BC|BA|QA|BO|NFR|RISK|METRIC)(-[A-Za-z0-9]+)*-[0-9]+" file.md。迁移时从文件名推 TYPE/NN、从来源章节推 SS,并生成稳定的 4 位十六进制 xxxx,替换全部出现处后重新校验;不要手工计算 SHA-256,BRD 第 7 节的字段提取边界可调用 python -m sdd_doc_lint.rehash --compute --doc-id NN --section-id SS --title T --description D。时间字段使用 ISO 8601,格式 YYYY-MM-DDTHH:MM:SS,可带 Z 或 ±HH:MM,纯日期已弃用。
限制:校验规则以 framework/governance/ID_NAMING_STANDARDS.md 为权威,阈值规则见 THRESHOLD_NAMING_RULES.md;它不处理跨文档可追溯性、不做内容审查,也不产出工件。具体收费、平台与效果资料暂未提供。