已合并
[Bugfix] 修复 PR 800 词条文档类型命名与校验链接规范问题 #815
joejoezhou创建于 24 天前
[Bugfix] 修复 PR 800 词条文档类型命名与校验链接规范问题 #815
已合并
共 20 个文件变更+231-226
| @@ -9,10 +9,10 @@ | |||
| 9 | | 编号 | 校验条目 | 判定条件 | 处理建议 | | 9 | | 编号 | 校验条目 | 判定条件 | 处理建议 | |
| 10 | | :--- | :--- | :--- | :--- | | 10 | | :--- | :--- | :--- | :--- | |
| 11 | | CE-01 | 模板占位符 | 文件中不残留模板占位符 `{{ ... }}`。 | 将占位符替换为实际内容 | | 11 | | CE-01 | 模板占位符 | 文件中不残留模板占位符 `{{ ... }}`。 | 将占位符替换为实际内容 | |
| 12 | -| CE-02 | 模板注释 | 文件中不残留模板注释或模板自带的教学性章节（以 `> **注释：**` 开头、含“将 xxx 替换为”“必填”“选填”等指导性文字；或如“排版规范”这类仅指导文档编写、与发布内容无关的模板脚手架章节）。 | 删除模板注释或脚手架章节，或替换为正式说明 | | 12 | +| CE-02 | 模板注释 | 文件中不残留模板注释或模板自带的教学性章节（以 `> **注释：**` 开头、含“将 xxx 替换为”“必填”“选填”等指导性文字；或为仅指导文档编写、与发布内容无关的模板脚手架章节）。 | 删除模板注释或脚手架章节，或替换为正式说明 | |
| 13 | | CE-03 | 敏感信息 | 文档不包含密钥、令牌、内部地址、个人路径或其他敏感信息。 | 移除敏感信息，替换为占位说明 | | 13 | | CE-03 | 敏感信息 | 文档不包含密钥、令牌、内部地址、个人路径或其他敏感信息。 | 移除敏感信息，替换为占位说明 | |
| 14 | | CE-04 | 标题 | 文档存在且仅存在一个一级标题（H1），且与文档主题一致。 | 修正标题 | | 14 | | CE-04 | 标题 | 文档存在且仅存在一个一级标题（H1），且与文档主题一致。 | 修正标题 | |
| 15 | -| CE-05 | 书名号 | 文档正文引用其他文档标题时，标题以书名号《》括起（含链接锚文本，如 `[《XX 在 msModelSlim 中的完整实现》](…)`）；正文中单独提及的文档标题亦使用书名号。 | 标题补加书名号 | | 15 | +| CE-05 | 书名号 | 文档正文引用其他文档标题时，标题以书名号《》括起（含链接引用：书名号内为锚文本链接，锚文本为目标文档正式标题、链接为相对路径，如 `《[XX 在 msModelSlim 中的完整实现](../../quantization_algorithms/xxx.md)》`）；正文中单独提及的文档标题亦使用书名号。 | 标题补加书名号 | |
| 16 | | CE-06 | 数字与单位间距 | 中文语境下数字与量词/单位之间不留空格，如 `≤5个`、`5类`、`80~200字`；不得写作 `≤ 5 个`、`5 类`。 | 删除数字与单位间空格 | | 16 | | CE-06 | 数字与单位间距 | 中文语境下数字与量词/单位之间不留空格，如 `≤5个`、`5类`、`80~200字`；不得写作 `≤ 5 个`、`5 类`。 | 删除数字与单位间空格 | |
| 17 | 17 | ||
| 18 | ### 1.2 WARN（建议满足） | 18 | ### 1.2 WARN（建议满足） |
| @@ -20,7 +20,7 @@ | |||
| 20 | | 编号 | 校验条目 | 判定条件 | 处理建议 | | 20 | | 编号 | 校验条目 | 判定条件 | 处理建议 | |
| 21 | | :--- | :--- | :--- | :--- | | 21 | | :--- | :--- | :--- | :--- | |
| 22 | | CW-01 | 可选章节 | `[OPTIONAL]` 前缀仅用于模板定义的可选章节；发布文档时已删除不适用的可选章节及前缀，删除后章节按顺序重新编号、不留空号。 | 删除不适用的 `[OPTIONAL]` 章节，保留的章节去掉前缀并按序重排 | | 22 | | CW-01 | 可选章节 | `[OPTIONAL]` 前缀仅用于模板定义的可选章节；发布文档时已删除不适用的可选章节及前缀，删除后章节按顺序重新编号、不留空号。 | 删除不适用的 `[OPTIONAL]` 章节，保留的章节去掉前缀并按序重排 | |
| 23 | -| CW-02 | 渲染与链接 | Markdown 表格、标题层级、代码块语言标记和换行渲染正确；内联文档链接有效。 | 修正格式错误或失效链接 | | 23 | +| CW-02 | 渲染与链接 | Markdown 表格、标题层级、代码块语言标记和换行渲染正确；内联文档链接为相对路径且可解析。 | 修正格式错误或失效链接 | |
| 24 | 24 | ||
| 25 | ## 2. 使用说明 | 25 | ## 2. 使用说明 |
| 26 | 26 | ||
| @@ -1,79 +0,0 @@ | |||
| 1 | -# 量化术语百科校验清单 | ||
| 2 | - | ||
| 3 | -> 用于校验基于[《量化术语百科词条模板》](01_quantization_glossary_template.md)新建或整改的术语百科文档。通用校验条目与校验机制（使用说明 / 校验执行 / 豁免机制）见[《公共校验清单》](00_common_checklist.md)；以下为术语百科类型专属校验条目，按严重级别分表。 | ||
| 4 | - | ||
| 5 | -## 1. 校验条目 | ||
| 6 | - | ||
| 7 | -### 1.1 ERROR（必须满足） | ||
| 8 | - | ||
| 9 | -| 编号 | 校验条目 | 判定条件 | 处理建议 | | ||
| 10 | -| :--- | :--- | :--- | :--- | | ||
| 11 | -| G01 | 文件命名 | 文件命名为 `term_<english_name>.md`，`english_name` 为全小写英文，多词以下划线连接。 | 重命名文件 | | ||
| 12 | -| G02 | 文件编码 | 文件以 UTF-8（建议带 BOM，与现有量化算法文档保持一致）编码。 | 转换编码 | | ||
| 13 | -| S01 | 必填章节 | 必填章节不缺失：一级标题、顶部信息框、`## 概述`、`## 原理`（含 `### 核心思想`、`### 数学描述`、`### 关键性质`）、`## 适用场景与限制`（含 `### 适用场景`、`### 使用限制`）、`## 关联流程`、`## 关联词条`、`## 参考资料`。 | 补齐缺失章节 | | ||
| 14 | -| S03 | 章节顺序 | 章节顺序与模板“章节必要性一览”一致。 | 调整章节顺序 | | ||
| 15 | -| S05 | 顶部信息框字段 | 顶部信息框至少包含 `词条类别`、`英文名称`、`应用领域` 三项。 | 补充字段 | | ||
| 16 | -| S06 | 词条类别取值 | 顶部信息框 `词条类别` 取值在模板允许的枚举集合内（量化基础概念 / 量化算法 / 离群值抑制算法 / 敏感层分析算法 / 自动调优策略 / 量化数据格式 / 量化参数 / 量化配置项 / 量化工具接口 / 量化评估指标 / 其他）。 | 修正取值 | | ||
| 17 | -| S08 | 关键性质条目数 | `### 关键性质` 至少包含3条列表项。 | 补充性质 | | ||
| 18 | -| S09 | 适用场景与使用限制条目数 | `### 适用场景` 至少包含2条；`### 使用限制` 至少包含2条。 | 补充内容 | | ||
| 19 | -| S10 | 实现章节的条件出现 | `[OPTIONAL] ## 在 msModelSlim 中的实现` 为“有条件出现”章节：仅当术语在 msModelSlim 代码库中有直接实现时写入；若整体省略，其下三个子章节全部省略；若出现任一子章节，则 `### 实现位置` 必填。 | 补齐或整体省略，禁止无实现时保留空章节 | | ||
| 20 | -| S11 | 二级标题分隔符 | 除一级标题外，每一个二级标题（`## xxx`）出现前有一行 `---` 水平分隔符（含顶部信息框与首个二级标题之间、所有二级标题之间）；三级标题（`###`）前不插入 `---`。 | 补充或移除 `---` | | ||
| 21 | -| S12 | 子标题编号 | 同一二级章节下多个并列三级标题（`###`）使用阿拉伯数字连续编号 `### 1. xxx`、`### 2. xxx`；四级标题（`####`）使用“父级编号.子序号”形式 `#### 2.1 xxx`，编号连续递增、不跳号不重复；仅一个三级标题时可省略编号。 | 补充/修正编号 | | ||
| 22 | -| L01 | 关联词条链接形式 | `## 关联词条` 中每一项为 markdown 超链接形式：同领域用 `[词条名](./term_xxx.md)`，跨领域用相对路径 `[词条名](../其他领域目录/term_xxx.md)`，不允许纯文本词条名。 | 改为超链接 | | ||
| 23 | -| L02 | 关联词条数量 | `## 关联词条` 至少包含3条关联词条。 | 补充关联词条 | | ||
| 24 | -| L03 | 关系类型标注 | `## 关联词条` 每一项显式标注关系类型（上位概念 / 下位概念 / 同类算法 / 对比算法 / 前置术语 / 后续术语 / 配套术语 / 应用对象 / 评估指标 / 其他）。 | 补充关系类型 | | ||
| 25 | -| L05 | 概述超链接 | `## 概述` 正文中提及的、已存在或将存在的术语百科词条，至少1处以超链接形式 `[词条名](./term_xxx.md)` 出现。 | 补充超链接 | | ||
| 26 | -| L07 | 关联流程非空 | `## 关联流程` 不可为空；若无关联流程，显式写“暂无关联流程”。 | 补充内容或占位文字 | | ||
| 27 | -| L09 | 链接路径可解析 | 所有 markdown 链接的相对路径能在仓库内解析（含跨领域相对路径；不允许指向仓库外绝对路径或外网 URL，参考资料除外）。 | 修正路径 | | ||
| 28 | -| C01 | 概述非空 | `## 概述` 不为空，建议字数80~200字。 | 补充概述 | | ||
| 29 | -| C02 | 概述三要素 | `## 概述` 回答三个问题：是什么 / 解决什么问题 / 核心特征。 | 重写概述 | | ||
| 30 | -| C03 | 数学描述非空 | `### 数学描述` 不为空；非算法类术语可用形式化定义替代公式。 | 补充公式或形式化定义 | | ||
| 31 | -| C04 | 公式语法 | 数学公式使用 LaTeX 语法：行内公式用 `$...$`，块级公式用 `$$...$$`；禁止使用反引号代码块标记包裹公式（包括正文中的公式引用）。 | 替换为 LaTeX 语法 | | ||
| 32 | -| C05 | 变量说明 | 块级公式下方列出公式中所有变量的含义说明。 | 补充变量说明 | | ||
| 33 | -| C06 | 参考资料数量 | `## 参考资料` 至少包含1条参考资料。 | 补充参考资料 | | ||
| 34 | -| C08 | 知识类型 | 词条内容不直接复制算法说明书的完整章节；术语百科侧重“陈述性知识”（原理/性质/关联），算法说明书侧重“过程性知识”（步骤/配置/FAQ）。 | 重写为陈述性表述 | | ||
| 35 | -| C10 | 占位残留 | 文档不含占位样例（如 `xxx`、`TODO`、`FIXME`、`待补充`、`TBD`）。 | 补充实际内容 | | ||
| 36 | -| C13 | 流程图面积 | `## 流程示意` 章节中的流程图/图片控制占用面积，避免单图占据过多纵向空间：mermaid 节点数 ≤8个，超过应合并或拆分；节点文本精简，单节点 ≤15个汉字。 | 简化流程图或拆分为多张子图 | | ||
| 37 | -| C18 | mermaid 顶层 | mermaid 代码块不被 HTML 标签（如 `<div align="center">`）包裹；mermaid 位于 markdown 顶层。 | 移除包裹的 HTML 标签 | | ||
| 38 | -| P01 | 核心思想不重复 | `### 核心思想` 不与 `## 概述` 文本高度重复（相似度阈值 0.6）。 | 重写核心思想 | | ||
| 39 | -| P02 | 变量定义 | 数学公式中所有变量在公式下方列表中说明，禁止“未定义变量”。 | 补充变量说明 | | ||
| 40 | -| P04 | 符号一致 | 公式中变量符号在公式与说明列表中一致（大小写、下标）。 | 统一符号 | | ||
| 41 | -| R01 | 链接一致性 | `## 关联词条` 中每个链接目标与显示文本指向同一术语（避免“显示 A 链接到 B”）。 | 修正锚文本或链接 | | ||
| 42 | -| R03 | 外链可信 | `## 参考资料` 中外部链接为 HTTPS，且为 arXiv、官方会议/期刊、msModelSlim 仓库内文档之一。 | 替换为可信链接 | | ||
| 43 | -| R05 | 内链相对路径 | `## 参考资料` 中的仓库内文档链接使用相对路径，且文件存在。 | 修正路径 | | ||
| 44 | -| K02 | 待建词条登记 | `## 关联词条` 中的所有链接目标在未来词条扩充后必须存在；当前阶段若目标缺失，须在词条文件顶部 TODO 列表登记。本条目优先级高于 L04：只要目标词条已登记 TODO，即可通过本项校验，L04 的 WARN 可同步豁免。 | 登记待建词条 | | ||
| 45 | -| K04 | 词条唯一性 | 同一术语不在 `docs/zh/knowledge_base/` 同一领域目录下存在多个词条文件（同名/同 `english_name`）。 | 合并或重命名 | | ||
| 46 | - | ||
| 47 | -### 1.2 WARN（建议满足） | ||
| 48 | - | ||
| 49 | -| 编号 | 校验条目 | 判定条件 | 处理建议 | | ||
| 50 | -| :--- | :--- | :--- | :--- | | ||
| 51 | -| G05 | 一级标题 | 文件首行为一级标题 `# <词条名>`，与文件名中 `english_name` 对应的中文名保持一致。 | 调整标题 | | ||
| 52 | -| G07 | 缩进 | 文件不使用 Tab 缩进（统一使用空格）。 | 替换为空格 | | ||
| 53 | -| S04 | 目录 | 词条文件不包含目录（模板中已移除目录）。 | 删除目录相关文本 | | ||
| 54 | -| S07 | 英文名称一致性 | 顶部信息框 `英文名称` 与文件名 `term_<english_name>.md` 中的 `english_name` 一致（大小写可不一致，拼写一致）。 | 统一命名 | | ||
| 55 | -| L04 | 链接目标存在性 | `## 关联词条` 与 `## 关联流程` 中所有 `./term_xxx.md` 链接指向实际存在的同目录词条文件。若目标词条尚在规划中（已在文件顶部 TODO 列表登记），可豁免本项检查，由 K02 作为唯一 ERROR 级的存在性校验。 | 修正链接或补齐被引用词条；若已登记 TODO 则豁免 | | ||
| 56 | -| L06 | 关联流程链接 | `## 关联流程` 中每一项为 markdown 超链接，并指向 `docs/zh/` 下实际存在的流程指南文档。 | 修正链接 | | ||
| 57 | -| L08 | 正文术语链接 | 正文中提及的术语名（如 SmoothQuant、GPTQ、per_token 等），若该术语已有或将有独立词条，使用超链接而非纯文本。 | 改为超链接 | | ||
| 58 | -| L10 | 锚文本 | 超链接显示文本与目标词条的一级标题一致，避免“点此”“详见”等无信息量锚文本。 | 改用词条名作为锚文本 | | ||
| 59 | -| C07 | 参考资料字段 | 学术参考资料包含：标题、作者、会议/期刊、年份、链接（arXiv 或官方）。 | 补全字段 | | ||
| 60 | -| C09 | 使用限制 | `## 适用场景与限制` 中“使用限制”至少包含1条前置条件或不适用场景。 | 补充限制 | | ||
| 61 | -| C11 | 图片路径 | 图片（若有）放在词条同级的 `figures/` 子目录下，并使用相对路径引用。 | 移动图片并修正路径 | | ||
| 62 | -| C12 | 代码块语言 | 代码块标注语言（如 ` ```yaml `、` ```python `、` ```text `），不使用裸代码块。 | 补充语言标注 | | ||
| 63 | -| C14 | 流程图科普性 | `## 流程示意` 中流程图保持科普性，仅提供简化概览；深度算法步骤与代码级解析通过超链接（如引用块形式）指向算法说明文档，流程图节点 ≤5个。 | 简化流程图或补充超链接引导 | | ||
| 64 | -| C15 | 实现章节科普性 | `## 在 msModelSlim 中的实现` 章节保持科普性，避免罗列过多代码模块详细路径；完整的代码架构解析与模块调用链路通过超链接引用到算法说明文档。 | 精简路径列表，补充超链接引导 | | ||
| 65 | -| C16 | 首次提出出处 | 顶部信息框 `首次提出` 字段有明确出处（作者、会议/期刊、年份），不填写“msModelSlim 自研算法”等无来源信息；无明确出处则删除该行。 | 删除该行或补充真实出处 | | ||
| 66 | -| C17 | 配置示例注释 | `### 配置示例` 中的 YAML 不含逐行注释说明参数含义；详细参数说明通过引用块超链接引导至算法说明文档。 | 移除注释，补充超链接引导 | | ||
| 67 | -| P03 | 推导步骤 | 多步推导使用编号公式，避免跳跃。 | 增加推导步骤 | | ||
| 68 | -| P05 | 数学性质 | 若术语涉及对称性/等价变换/可逆性等数学性质，在 `### 关键性质` 中显式列出。 | 补充性质条目 | | ||
| 69 | -| R02 | 关系类型多样 | 关联词条覆盖至少2种关系类型（如同时包含“上位概念”与“配套术语”），避免关系单一。 | 补充异构关系词条 | | ||
| 70 | -| R04 | 论文置首 | 若术语源自学术论文，`## 参考资料` 第1条为该论文。 | 调整参考资料顺序 | | ||
| 71 | -| R06 | 关联流程说明 | `## 关联流程` 中至少1项说明关系（如“使用本算法作为前置处理”），而非仅列链接。 | 补充关系说明 | | ||
| 72 | -| K01 | 反向引用 | 每个词条至少被其他1个词条在 `## 关联词条` 中引用（入度 ≥1）。 | 补充反向引用 | | ||
| 73 | -| K03 | 弱连通图 | 术语百科整体构成弱连通图（任一词条可经关联词条链接到达另一词条）。 | 补充跨簇关联词条 | | ||
| 74 | - | ||
| 75 | -## 2. 类型使用说明 | ||
| 76 | - | ||
| 77 | -- **编号**：`GXX`（通用类）、`SXX`（结构类）、`LXX`（链接类）、`CXX`（内容类）、`PXX`（原理与公式类）、`RXX`（关联与参考资料类）、`KXX`（知识图谱类）；类别内编号保留原序号（移除的通用条目见《公共校验清单》）。 | ||
| 78 | -- **校验范围**：`docs/zh/knowledge_base/` 各领域（子）目录下的 `term_*.md` 术语词条（词条就近放在所属领域目录）。 | ||
| 79 | -- **修复优先级**：G > S > L > C > P > R > K（通用与结构问题优先修复，避免后续连锁失败）。 | ||
| @@ -0,0 +1,76 @@ | |||
| 1 | +# 术语词条校验清单 | ||
| 2 | + | ||
| 3 | +> 用于校验基于《[术语词条模板](01_term_glossary_template.md)》新建或整改的术语词条文档。通用校验条目与校验机制（使用说明 / 校验执行 / 豁免机制）见《[公共校验清单](00_common_checklist.md)》；以下为术语词条类型专属校验条目，按严重级别分表。 | ||
| 4 | + | ||
| 5 | +## 1. 校验条目 | ||
| 6 | + | ||
| 7 | +### 1.1 ERROR（必须满足） | ||
| 8 | + | ||
| 9 | +| 编号 | 校验条目 | 判定条件 | 处理建议 | | ||
| 10 | +| :--- | :--- | :--- | :--- | | ||
| 11 | +| TE-01 | 文件命名 | 文件命名为 `term_<english_name>.md`，`english_name` 为全小写英文，多词以下划线连接。 | 重命名文件 | | ||
| 12 | +| TE-02 | 文件编码 | 文件以 UTF-8（建议带 BOM，与现有量化算法文档保持一致）编码。 | 转换编码 | | ||
| 13 | +| TE-03 | 必填章节 | 必填章节不缺失：一级标题、顶部信息框、`## 概述`、`## 原理`（含 `### 核心思想`、`### 数学描述`、`### 关键性质`）、`## 适用场景与限制`（含 `### 适用场景`、`### 使用限制`）、`## 关联流程`、`## 关联词条`、`## 参考资料`。 | 补齐缺失章节 | | ||
| 14 | +| TE-04 | 章节顺序 | 章节顺序与模板“章节必要性一览”一致。 | 调整章节顺序 | | ||
| 15 | +| TE-05 | 顶部信息框字段 | 顶部信息框至少包含 `词条类别`、`英文名称`、`应用领域` 三项。 | 补充字段 | | ||
| 16 | +| TE-06 | 词条类别取值 | 顶部信息框 `词条类别` 取值在模板允许的枚举集合内（量化基础概念 / 量化算法 / 离群值抑制算法 / 敏感层分析算法 / 自动调优策略 / 量化数据格式 / 量化参数 / 量化配置项 / 量化工具接口 / 量化评估指标 / 其他）。 | 修正取值 | | ||
| 17 | +| TE-07 | 关键性质条目数 | `### 关键性质` 至少包含3条列表项。 | 补充性质 | | ||
| 18 | +| TE-08 | 适用场景与使用限制条目数 | `### 适用场景` 至少包含2条；`### 使用限制` 至少包含2条。 | 补充内容 | | ||
| 19 | +| TE-09 | 实现章节的条件出现 | `## [OPTIONAL] 在 msModelSlim 中的实现` 为“有条件出现”章节：仅当术语在 msModelSlim 代码库中有直接实现时写入；若整体省略，其下三个子章节全部省略；若出现任一子章节，则 `### 实现位置` 必填。 | 补齐或整体省略，禁止无实现时保留空章节 | | ||
| 20 | +| TE-10 | 二级标题分隔符 | 除一级标题外，每一个二级标题（`## xxx`）出现前有一行 `---` 水平分隔符（含顶部信息框与首个二级标题之间、所有二级标题之间）；三级标题（`###`）前不插入 `---`。 | 补充或移除 `---` | | ||
| 21 | +| TE-11 | 子标题编号 | 同一二级章节下多个并列三级标题（`###`）使用阿拉伯数字连续编号 `### 1. xxx`、`### 2. xxx`；四级标题（`####`）使用“父级编号.子序号”形式 `#### 2.1 xxx`，编号连续递增、不跳号不重复；仅一个三级标题时可省略编号。 | 补充/修正编号 | | ||
| 22 | +| TE-12 | 关联词条链接形式 | `## 关联词条` 中每一项为 markdown 超链接形式：同领域用 `《[词条名](./term_xxx.md)》`，跨领域用相对路径 `《[词条名](../其他领域目录/term_xxx.md)》`，不允许纯文本词条名。 | 改为超链接 | | ||
| 23 | +| TE-13 | 关联词条数量 | `## 关联词条` 至少包含3条关联词条。 | 补充关联词条 | | ||
| 24 | +| TE-14 | 关系类型标注 | `## 关联词条` 每一项显式标注关系类型（上位概念 / 下位概念 / 同类算法 / 对比算法 / 前置术语 / 后续术语 / 配套术语 / 应用对象 / 评估指标 / 其他）。 | 补充关系类型 | | ||
| 25 | +| TE-15 | 概述超链接 | `## 概述` 正文中提及的、已存在或将存在的术语词条，至少1处以超链接形式 `《[词条名](./term_xxx.md)》` 出现。 | 补充超链接 | | ||
| 26 | +| TE-16 | 关联流程非空 | `## 关联流程` 不可为空；若无关联流程，显式写“暂无关联流程”。 | 补充内容或占位文字 | | ||
| 27 | +| TE-17 | 链接路径可解析 | 所有 markdown 链接的相对路径能在仓库内解析（含跨领域相对路径；不允许指向仓库外绝对路径或外网 URL，参考资料除外）。 | 修正路径 | | ||
| 28 | +| TE-18 | 概述非空 | `## 概述` 不为空，建议字数80~200字。 | 补充概述 | | ||
| 29 | +| TE-19 | 概述三要素 | `## 概述` 回答三个问题：是什么 / 解决什么问题 / 核心特征。 | 重写概述 | | ||
| 30 | +| TE-20 | 数学描述非空 | `### 数学描述` 不为空；非算法类术语可用形式化定义替代公式。 | 补充公式或形式化定义 | | ||
| 31 | +| TE-21 | 公式语法 | 数学公式使用 LaTeX 语法：行内公式用 `$...$`，块级公式用 `$$...$$`；禁止使用反引号代码块标记包裹公式（包括正文中的公式引用）。 | 替换为 LaTeX 语法 | | ||
| 32 | +| TE-22 | 变量说明 | 块级公式下方列出公式中所有变量的含义说明。 | 补充变量说明 | | ||
| 33 | +| TE-23 | 参考资料数量 | `## 参考资料` 至少包含1条参考资料。 | 补充参考资料 | | ||
| 34 | +| TE-24 | 知识类型 | 词条内容不直接复制算法说明书的完整章节；术语百科侧重“陈述性知识”（原理/性质/关联），算法说明书侧重“过程性知识”（步骤/配置/FAQ）。 | 重写为陈述性表述 | | ||
| 35 | +| TE-25 | 占位残留 | 文档不含占位样例（如 `xxx`、`TODO`、`FIXME`、`待补充`、`TBD`）。 | 补充实际内容 | | ||
| 36 | +| TE-26 | mermaid 顶层 | mermaid 代码块不被 HTML 标签（如 `<div align="center">`）包裹；mermaid 位于 markdown 顶层。 | 移除包裹的 HTML 标签 | | ||
| 37 | +| TE-27 | 核心思想不重复 | `### 核心思想` 不与 `## 概述` 文本高度重复（相似度阈值 0.6）。 | 重写核心思想 | | ||
| 38 | +| TE-28 | 变量定义 | 数学公式中所有变量在公式下方列表中说明，禁止“未定义变量”。 | 补充变量说明 | | ||
| 39 | +| TE-29 | 符号一致 | 公式中变量符号在公式与说明列表中一致（大小写、下标）。 | 统一符号 | | ||
| 40 | +| TE-30 | 链接一致性 | `## 关联词条` 中每个链接目标与显示文本指向同一术语（避免“显示 A 链接到 B”）。 | 修正锚文本或链接 | | ||
| 41 | +| TE-31 | 外链可信 | `## 参考资料` 中外部链接为 HTTPS，且为 arXiv、官方会议/期刊、msModelSlim 仓库内文档之一。 | 替换为可信链接 | | ||
| 42 | +| TE-32 | 内链相对路径 | `## 参考资料` 中的仓库内文档链接使用相对路径，且文件存在。 | 修正路径 | | ||
| 43 | +| TE-33 | 待建词条登记 | `## 关联词条` 中的所有链接目标在未来词条扩充后必须存在；当前阶段若目标缺失，须在词条文件顶部 TODO 列表登记。本条目优先级高于 TW-05：只要目标词条已登记 TODO，即可通过本项校验，TW-05 的 WARN 可同步豁免。 | 登记待建词条 | | ||
| 44 | +| TE-34 | 词条唯一性 | 同一术语不在 `docs/zh/knowledge_base/` 同一领域目录下存在多个词条文件（同名/同 `english_name`）。 | 合并或重命名 | | ||
| 45 | + | ||
| 46 | +### 1.2 WARN（建议满足） | ||
| 47 | + | ||
| 48 | +| 编号 | 校验条目 | 判定条件 | 处理建议 | | ||
| 49 | +| :--- | :--- | :--- | :--- | | ||
| 50 | +| TW-01 | 一级标题 | 文件首行为一级标题 `# <词条名>`，与文件名中 `english_name` 对应的中文名保持一致。 | 调整标题 | | ||
| 51 | +| TW-02 | 缩进 | 文件不使用 Tab 缩进（统一使用空格）。 | 替换为空格 | | ||
| 52 | +| TW-03 | 目录 | 词条文件不包含目录（模板中已移除目录）。 | 删除目录相关文本 | | ||
| 53 | +| TW-04 | 英文名称一致性 | 顶部信息框 `英文名称` 与文件名 `term_<english_name>.md` 中的 `english_name` 一致（大小写可不一致，拼写一致）。 | 统一命名 | | ||
| 54 | +| TW-05 | 链接目标存在性 | `## 关联词条` 与 `## 关联流程` 中所有 `./term_xxx.md` 链接指向实际存在的同目录词条文件。若目标词条尚在规划中（已在文件顶部 TODO 列表登记），可豁免本项检查，由 TE-33 作为唯一 ERROR 级的存在性校验。 | 修正链接或补齐被引用词条；若已登记 TODO 则豁免 | | ||
| 55 | +| TW-06 | 关联流程链接 | `## 关联流程` 中每一项为 markdown 超链接，并指向 `docs/zh/` 下实际存在的流程指南文档。 | 修正链接 | | ||
| 56 | +| TW-07 | 正文术语链接 | 正文中提及的术语名（如 SmoothQuant、GPTQ、per_token 等），若该术语已有或将有独立词条，使用超链接而非纯文本。 | 改为超链接 | | ||
| 57 | +| TW-08 | 锚文本 | 超链接显示文本与目标词条的一级标题一致，避免“点此”“详见”等无信息量锚文本。 | 改用词条名作为锚文本 | | ||
| 58 | +| TW-09 | 参考资料字段 | 学术参考资料包含：标题、作者、会议/期刊、年份、链接（arXiv 或官方）。 | 补全字段 | | ||
| 59 | +| TW-10 | 图片路径 | 图片（若有）放在词条同级的 `figures/` 子目录下，并使用相对路径引用。 | 移动图片并修正路径 | | ||
| 60 | +| TW-11 | 代码块语言 | 代码块标注语言（如 ` ```yaml `、` ```python `、` ```text `），不使用裸代码块。 | 补充语言标注 | | ||
| 61 | +| TW-12 | 实现章节科普性 | `## 在 msModelSlim 中的实现` 章节保持科普性，避免罗列过多代码模块详细路径；完整的代码架构解析与模块调用链路通过超链接引用到算法说明文档。 | 精简路径列表，补充超链接引导 | | ||
| 62 | +| TW-13 | 首次提出出处 | 顶部信息框 `首次提出` 字段有明确出处（作者、会议/期刊、年份），不填写“msModelSlim 自研算法”等无来源信息；无明确出处则删除该行。 | 删除该行或补充真实出处 | | ||
| 63 | +| TW-14 | 配置示例注释 | `### 配置示例` 中的 YAML 不含逐行注释说明参数含义；详细参数说明通过引用块超链接引导至算法说明文档。 | 移除注释，补充超链接引导 | | ||
| 64 | +| TW-15 | 推导步骤 | 多步推导使用编号公式，避免跳跃。 | 增加推导步骤 | | ||
| 65 | +| TW-16 | 数学性质 | 若术语涉及对称性/等价变换/可逆性等数学性质，在 `### 关键性质` 中显式列出。 | 补充性质条目 | | ||
| 66 | +| TW-17 | 关系类型多样 | 关联词条覆盖至少2种关系类型（如同时包含“上位概念”与“配套术语”），避免关系单一。 | 补充异构关系词条 | | ||
| 67 | +| TW-18 | 论文置首 | 若术语源自学术论文，`## 参考资料` 第1条为该论文。 | 调整参考资料顺序 | | ||
| 68 | +| TW-19 | 关联流程说明 | `## 关联流程` 中至少1项说明关系（如“使用本算法作为前置处理”），而非仅列链接。 | 补充关系说明 | | ||
| 69 | +| TW-20 | 反向引用 | 每个词条至少被其他1个词条在 `## 关联词条` 中引用（入度 ≥1）。 | 补充反向引用 | | ||
| 70 | +| TW-21 | 弱连通图 | 术语百科整体构成弱连通图（任一词条可经关联词条链接到达另一词条）。 | 补充跨簇关联词条 | | ||
| 71 | + | ||
| 72 | +## 2. 类型使用说明 | ||
| 73 | + | ||
| 74 | +- **编号**：术语词条条目以 `TE-`（ERROR）/ `TW-`（WARN）为前缀，按严重级别分表连续编号，不再按内容类别（G/S/L/C/P/R/K）细分；通用条目见《[公共校验清单](./00_common_checklist.md)》CE/CW。 | ||
| 75 | +- **校验范围**：`docs/zh/knowledge_base/` 各领域（子）目录下的 `term_*.md` 术语词条（词条就近放在所属领域目录）。 | ||
| 76 | +- **修复优先级**：ERROR 条目优先于 WARN 条目（任一 ERROR 未解决即不通过）。 | ||
Rdocs/zh/contributing/development_guide/docs_standards/01_quantization_glossary_template.md→docs/zh/contributing/development_guide/docs_standards/01_term_glossary_template.md+13-13
| @@ -1,7 +1,7 @@ | |||
| 1 | -# {{ term_name }} 量化术语百科词条 | 1 | +# {{ term_name }} 术语词条 |
| 2 | 2 | ||
| 3 | > **注释：** | 3 | > **注释：** |
| 4 | -> 本文件是「量化术语百科」的**词条模板**，用于指导 agent 在 msModelSlim 知识库中新增/补全术语百科词条。 | 4 | +> 本文件是「术语百科」的**词条模板**，用于指导 agent 在 msModelSlim 知识库中新增/补全术语词条。 |
| 5 | > 使用约定如下： | 5 | > 使用约定如下： |
| 6 | > - `{{ content }}`：需要填充的内容，`content` 为英文，多词以下划线连接。 | 6 | > - `{{ content }}`：需要填充的内容，`content` 为英文，多词以下划线连接。 |
| 7 | > - `[OPTIONAL]`：前缀标签，表示该章节按需编写，无内容可省略整个章节。 | 7 | > - `[OPTIONAL]`：前缀标签，表示该章节按需编写，无内容可省略整个章节。 |
| @@ -9,7 +9,7 @@ | |||
| 9 | > | 9 | > |
| 10 | > - 术语百科以"陈述性知识"为主，区别于算法说明书（过程性知识）；本模板强调**知识原理**与**知识图谱（关联词条超链接）**。 | 10 | > - 术语百科以"陈述性知识"为主，区别于算法说明书（过程性知识）；本模板强调**知识原理**与**知识图谱（关联词条超链接）**。 |
| 11 | > - **模板灵活性说明**：本模板提供了一个推荐的词条结构，但并非强制严格遵循。某些章节可根据术语的实际情况省略（如 QAT 没有 msModelSlim 实现，则整个"在 msModelSlim 中的实现"章节可整体省略）。具体哪些章节可省略，请参考文末"章节必要性一览"表中的"可选"标记。词条编写应以"讲清楚术语本身"为首要目标，不必为了对齐模板结构而填充无关内容。 | 11 | > - **模板灵活性说明**：本模板提供了一个推荐的词条结构，但并非强制严格遵循。某些章节可根据术语的实际情况省略（如 QAT 没有 msModelSlim 实现，则整个"在 msModelSlim 中的实现"章节可整体省略）。具体哪些章节可省略，请参考文末"章节必要性一览"表中的"可选"标记。词条编写应以"讲清楚术语本身"为首要目标，不必为了对齐模板结构而填充无关内容。 |
| 12 | -> - **AI低错检查**：填写词条内容后，须按[《量化术语百科校验清单》](01_quantization_glossary_checklist.md)的 ERROR 条目逐项检查低错，包括但不限于错别字、中英文空格、标点全半角统一、语句通顺度、术语一致性等。生成词条后建议先做一遍低错自查再提交。 | 12 | +> - **AI低错检查**：填写词条内容后，须按《[术语词条校验清单](01_term_glossary_checklist.md)》的 ERROR 条目逐项检查低错，包括但不限于错别字、中英文空格、标点全半角统一、语句通顺度、术语一致性等。生成词条后建议先做一遍低错自查再提交。 |
| 13 | 13 | ||
| 14 | --- | 14 | --- |
| 15 | 15 | ||
| @@ -47,13 +47,13 @@ | |||
| 47 | > **注释：** 概述要求： | 47 | > **注释：** 概述要求： |
| 48 | > 1. 用一段话完成定义，建议80~200字。 | 48 | > 1. 用一段话完成定义，建议80~200字。 |
| 49 | > 2. 必须回答三个问题：是什么 / 解决什么问题 / 核心特征。 | 49 | > 2. 必须回答三个问题：是什么 / 解决什么问题 / 核心特征。 |
| 50 | -> 3. 行文中提及的、本身已存在或将来会存在的术语百科词条，必须以超链接形式呈现：'[词条名](./term_xxx.md)'。 | 50 | +> 3. 行文中提及的、本身已存在或将来会存在的术语词条，必须以超链接形式呈现：'《[词条名](./term_xxx.md)》'。 |
| 51 | > 4. 不要展开算法细节、不要复述完整公式。 | 51 | > 4. 不要展开算法细节、不要复述完整公式。 |
| 52 | > 5. 概述中提到的其他术语至少有1处以超链接形式出现（用于知识图谱构建）。 | 52 | > 5. 概述中提到的其他术语至少有1处以超链接形式出现（用于知识图谱构建）。 |
| 53 | 53 | ||
| 54 | --- | 54 | --- |
| 55 | 55 | ||
| 56 | -[OPTIONAL] ## 背景与动机 | 56 | +## [OPTIONAL] 背景与动机 |
| 57 | 57 | ||
| 58 | {{ background_and_motivation }} | 58 | {{ background_and_motivation }} |
| 59 | 59 | ||
| @@ -102,20 +102,20 @@ | |||
| 102 | 102 | ||
| 103 | --- | 103 | --- |
| 104 | 104 | ||
| 105 | -[OPTIONAL] ## 流程示意 | 105 | +## [OPTIONAL] 流程示意 |
| 106 | 106 | ||
| 107 | {{ flow_diagram }} | 107 | {{ flow_diagram }} |
| 108 | 108 | ||
| 109 | > **注释：** 重要：百科词条是科普性的，应循序渐进，避免杂糅算法流程、算法原理和代码实现。 | 109 | > **注释：** 重要：百科词条是科普性的，应循序渐进，避免杂糅算法流程、算法原理和代码实现。 |
| 110 | > 建议原则： | 110 | > 建议原则： |
| 111 | -> - 本章节仅提供**简化流程概览**（节点数 ≤5个），帮助读者形成整体认知。 | 111 | +> - 本章节仅提供**简化流程概览**（节点数 ≤8个，建议精简合并），帮助读者形成整体认知。 |
| 112 | > - 深度算法步骤、代码级解析应通过超链接引用到对应的算法说明文档。 | 112 | > - 深度算法步骤、代码级解析应通过超链接引用到对应的算法说明文档。 |
| 113 | > - 可在流程图上方的引用块中放置超链接引导，格式如下： | 113 | > - 可在流程图上方的引用块中放置超链接引导，格式如下： |
| 114 | > > 详细算法步骤与代码级解析，请参阅 '《[XX 在 msModelSlim 中的完整实现](../../quantization_algorithms/xxx.md)》'。 | 114 | > > 详细算法步骤与代码级解析，请参阅 '《[XX 在 msModelSlim 中的完整实现](../../quantization_algorithms/xxx.md)》'。 |
| 115 | > | 115 | > |
| 116 | > 图片须放在对应词条同级的 figures/ 目录下，引用时使用相对路径。 | 116 | > 图片须放在对应词条同级的 figures/ 目录下，引用时使用相对路径。 |
| 117 | > 无流程示意可省略整个章节。 | 117 | > 无流程示意可省略整个章节。 |
| 118 | -> 流程图大小适配要求（对应[《量化术语百科校验清单》](01_quantization_glossary_checklist.md)条目 C13、C18）： | 118 | +> 流程图大小适配要求（对应《[术语词条校验清单](01_term_glossary_checklist.md)》条目 TE-26）： |
| 119 | > - mermaid 节点数建议 ≤8个，超过应合并或拆分。 | 119 | > - mermaid 节点数建议 ≤8个，超过应合并或拆分。 |
| 120 | > - 节点文本精简，单节点 ≤15个汉字，超长用 <br/> 折行。 | 120 | > - 节点文本精简，单节点 ≤15个汉字，超长用 <br/> 折行。 |
| 121 | > - 默认 flowchart TD；纵向过长可改用 flowchart LR。 | 121 | > - 默认 flowchart TD；纵向过长可改用 flowchart LR。 |
| @@ -135,7 +135,7 @@ | |||
| 135 | 135 | ||
| 136 | --- | 136 | --- |
| 137 | 137 | ||
| 138 | -[OPTIONAL] ## 在 msModelSlim 中的实现 | 138 | +## [OPTIONAL] 在 msModelSlim 中的实现 |
| 139 | 139 | ||
| 140 | > **注释：** 重要：本章节为"有条件出现"章节。 | 140 | > **注释：** 重要：本章节为"有条件出现"章节。 |
| 141 | > 出现条件：仅当该术语在 msModelSlim 代码库中已有直接实现代码时，才应写入本章节。 | 141 | > 出现条件：仅当该术语在 msModelSlim 代码库中已有直接实现代码时，才应写入本章节。 |
| @@ -223,7 +223,7 @@ | |||
| 223 | {{ related_terms }} | 223 | {{ related_terms }} |
| 224 | 224 | ||
| 225 | > **注释：** 关联词条列表要求（重点校验项 AR-2.1）： | 225 | > **注释：** 关联词条列表要求（重点校验项 AR-2.1）： |
| 226 | -> 1. 必须使用超链接形式指向其他术语百科词条：'[词条名](./term_xxx.md)'。 | 226 | +> 1. 必须使用超链接形式指向其他术语词条：'《[词条名](./term_xxx.md)》'。 |
| 227 | > 2. 禁止出现纯文本词条名（必须可点击）。 | 227 | > 2. 禁止出现纯文本词条名（必须可点击）。 |
| 228 | > 3. 至少给出3条关联词条。 | 228 | > 3. 至少给出3条关联词条。 |
| 229 | > 4. 每个关联词条后须用括号或冒号简短说明关系类型，关系类型包括但不限于： | 229 | > 4. 每个关联词条后须用括号或冒号简短说明关系类型，关系类型包括但不限于： |
| @@ -231,9 +231,9 @@ | |||
| 231 | > 5. 本节中如有引用本词条正文中未解释的术语，亦应使用超链接。 | 231 | > 5. 本节中如有引用本词条正文中未解释的术语，亦应使用超链接。 |
| 232 | > | 232 | > |
| 233 | > 示例： | 233 | > 示例： |
| 234 | -> - [《SmoothQuant》](./term_smooth_quant.md)：上位概念，同属离群值抑制算法族。 | 234 | +> - 《[SmoothQuant](./term_smooth_quant.md)》：上位概念，同属离群值抑制算法族。 |
| 235 | -> - [《GPTQ》](./term_gptq.md)：配套术语，常在本算法处理后接 GPTQ 权重量化。 | 235 | +> - 《[GPTQ](./term_gptq.md)》：配套术语，常在本算法处理后接 GPTQ 权重量化。 |
| 236 | -> - [《per_token》](./term_per_token.md)：应用对象，本算法平滑后激活更易于 per_token 量化。 | 236 | +> - 《[per_token](./term_per_token.md)》：应用对象，本算法平滑后激活更易于 per_token 量化。 |
| 237 | 237 | ||
| 238 | --- | 238 | --- |
| 239 | 239 | ||
| @@ -1,6 +1,6 @@ | |||
| 1 | # 流程指南校验清单 | 1 | # 流程指南校验清单 |
| 2 | 2 | ||
| 3 | -> 用于校验基于[《流程指南模板》](02_process_guide_template.md)新建或整改的文档。通用校验条目与校验机制（使用说明 / 校验执行 / 豁免机制）见[《公共校验清单》](00_common_checklist.md)；以下为流程指南类型专属校验条目，按严重级别分表。 | 3 | +> 用于校验基于《[流程指南模板](02_process_guide_template.md)》新建或整改的文档。通用校验条目与校验机制（使用说明 / 校验执行 / 豁免机制）见《[公共校验清单](00_common_checklist.md)》；以下为流程指南类型专属校验条目，按严重级别分表。 |
| 4 | 4 | ||
| 5 | ## 1. 校验条目 | 5 | ## 1. 校验条目 |
| 6 | 6 | ||
| @@ -8,22 +8,22 @@ | |||
| 8 | 8 | ||
| 9 | | 编号 | 校验条目 | 判定条件 | 处理建议 | | 9 | | 编号 | 校验条目 | 判定条件 | 处理建议 | |
| 10 | | :--- | :--- | :--- | :--- | | 10 | | :--- | :--- | :--- | :--- | |
| 11 | -| PG-001 | 核心章节 | 存在“适用范围”“输入和交付件”“操作步骤”三个核心章节。 | 补齐缺失章节 | | 11 | +| PE-01 | 核心章节 | 存在“适用范围”“输入和交付件”“操作步骤”三个核心章节。 | 补齐缺失章节 | |
| 12 | -| PG-002 | 输入与交付件 | “输入和交付件”章节同时包含至少一个输入项和至少一个交付件项。 | 补充输入或交付件项 | | 12 | +| PE-02 | 输入与交付件 | “输入和交付件”章节同时包含至少一个输入项和至少一个交付件项。 | 补充输入或交付件项 | |
| 13 | -| PG-003 | 操作步骤 | “操作步骤”章节包含至少一个步骤，且每个步骤同时包含“操作”和“输出”。 | 补充步骤或操作、输出 | | 13 | +| PE-03 | 操作步骤 | “操作步骤”章节包含至少一个步骤，且每个步骤同时包含“操作”和“输出”。 | 补充步骤或操作、输出 | |
| 14 | 14 | ||
| 15 | ### 1.2 WARN（建议满足） | 15 | ### 1.2 WARN（建议满足） |
| 16 | 16 | ||
| 17 | | 编号 | 校验条目 | 判定条件 | 处理建议 | | 17 | | 编号 | 校验条目 | 判定条件 | 处理建议 | |
| 18 | | :--- | :--- | :--- | :--- | | 18 | | :--- | :--- | :--- | :--- | |
| 19 | -| PG-004 | 标题与范围 | 标题能表达流程主题；适用范围说明适用对象、场景或边界。 | 调整标题或适用范围 | | 19 | +| PW-01 | 标题与范围 | 标题能表达流程主题；适用范围说明适用对象、场景或边界。 | 调整标题或适用范围 | |
| 20 | -| PG-005 | 输入与交付件 | 输入和交付件可定位，说明必要的来源、约束或验收方式。 | 补充来源、约束或验收方式 | | 20 | +| PW-02 | 输入与交付件 | 输入和交付件可定位，说明必要的来源、约束或验收方式。 | 补充来源、约束或验收方式 | |
| 21 | -| PG-006 | 步骤闭环 | 步骤顺序合理；按需要补充输入、执行前检查、通过条件、审计记录和异常处置。 | 补充步骤要素 | | 21 | +| PW-03 | 步骤闭环 | 步骤顺序合理；按需要补充输入、执行前检查、通过条件、审计记录和异常处置。 | 补充步骤要素 | |
| 22 | -| PG-007 | 命令与引用 | 命令、变量和路径有必要说明；引用的能力有证据来源。 | 补充说明或证据来源 | | 22 | +| PW-04 | 命令与引用 | 命令、变量和路径有必要说明；引用的能力有证据来源。 | 补充说明或证据来源 | |
| 23 | -| PG-008 | 特殊场景 | 涉及精度、性能、安全、产品形态、资源、发布或运行时，说明相应的基线、限制、验收、监控或回退安排。 | 补充相应安排 | | 23 | +| PW-05 | 特殊场景 | 涉及精度、性能、安全、产品形态、资源、发布或运行时，说明相应的基线、限制、验收、监控或回退安排。 | 补充相应安排 | |
| 24 | -| PG-009 | 流程关系与前置条件（可选） | 存在“流程关系与前置条件”章节时：上级流程、前置条件和后续操作可理解且与流程相符。 | 修正或补充相关说明 | | 24 | +| PW-06 | 流程关系与前置条件（可选） | 存在“流程关系与前置条件”章节时：上级流程、前置条件和后续操作可理解且与流程相符。 | 修正或补充相关说明 | |
| 25 | -| PG-010 | 全局验收条件（可选） | 存在“全局验收条件”章节时：条目说明整篇流程级通过要求。 | 补充条目 | | 25 | +| PW-07 | 全局验收条件（可选） | 存在“全局验收条件”章节时：条目说明整篇流程级通过要求。 | 补充条目 | |
| 26 | -| PG-011 | 全局异常处置（可选） | 存在“全局异常处置”章节时：条目说明异常现象、处理或回退方向。 | 补充条目 | | 26 | +| PW-08 | 全局异常处置（可选） | 存在“全局异常处置”章节时：条目说明异常现象、处理或回退方向。 | 补充条目 | |
| 27 | -| PG-012 | 案例列表 / 术语 / 接口文档列表（可选） | 存在相应章节时：每项仅保留名称和一句简述，且必须提供可跳转超链接；不以大段正文展开细节。 | 精简为名称 + 一句简述 + 链接 | | 27 | +| PW-09 | 案例列表 / 术语 / 接口文档列表（可选） | 存在相应章节时：每项仅保留名称和一句简述，且必须提供可跳转超链接；不以大段正文展开细节。 | 精简为名称 + 一句简述 + 链接 | |
| 28 | -| PG-013 | 流程总览（可选） | 存在“流程总览”章节时：位于“操作步骤”之前，并包含流程图、mermaid 图或其他示意图。 | 调整位置或补充示意图 | | 28 | +| PW-10 | 流程总览（可选） | 存在“流程总览”章节时：位于“操作步骤”之前，并包含流程图、mermaid 图或其他示意图。 | 调整位置或补充示意图 | |
| 29 | -| PG-014 | 安全说明 / 产品形态与资源限制（可选） | 存在相应章节时：安全、产品形态或资源约束与流程实际风险、部署形态、依赖或容量相匹配。 | 修正内容 | | 29 | +| PW-11 | 安全说明 / 产品形态与资源限制（可选） | 存在相应章节时：安全、产品形态或资源约束与流程实际风险、部署形态、依赖或容量相匹配。 | 修正内容 | |
| @@ -125,7 +125,7 @@ flowchart LR | |||
| 125 | 125 | ||
| 126 | | 案例 | 简述 | 链接 | | 126 | | 案例 | 简述 | 链接 | |
| 127 | | --- | --- | --- | | 127 | | --- | --- | --- | |
| 128 | -| {{case_name}} | {{case_summary}} | [{{case_link_text}}]({{case_link}}) | | 128 | +| {{case_name}} | {{case_summary}} | 《[{{case_link_text}}]({{case_link}})》 | |
| 129 | 129 | ||
| 130 | > **注释：** | 130 | > **注释：** |
| 131 | > 只做索引表：案例名、一句场景简述、可点击链接。详细步骤写在被链接的文档里，不要在本流程指南里展开长文。 | 131 | > 只做索引表：案例名、一句场景简述、可点击链接。详细步骤写在被链接的文档里，不要在本流程指南里展开长文。 |
| @@ -134,7 +134,7 @@ flowchart LR | |||
| 134 | 134 | ||
| 135 | | 术语 | 简述 | 链接 | | 135 | | 术语 | 简述 | 链接 | |
| 136 | | --- | --- | --- | | 136 | | --- | --- | --- | |
| 137 | -| {{term_name}} | {{term_summary}} | [{{term_link_text}}]({{term_link}}) | | 137 | +| {{term_name}} | {{term_summary}} | 《[{{term_link_text}}]({{term_link}})》 | |
| 138 | 138 | ||
| 139 | > **注释：** | 139 | > **注释：** |
| 140 | > 只做索引表：术语名、一句白话简述、指向权威定义或支持矩阵/算法文档的链接。不要在本表写长定义。 | 140 | > 只做索引表：术语名、一句白话简述、指向权威定义或支持矩阵/算法文档的链接。不要在本表写长定义。 |
| @@ -143,7 +143,7 @@ flowchart LR | |||
| 143 | 143 | ||
| 144 | | 接口或能力 | 简述 | 链接 | | 144 | | 接口或能力 | 简述 | 链接 | |
| 145 | | --- | --- | --- | | 145 | | --- | --- | --- | |
| 146 | -| {{interface_name}} | {{interface_summary}} | [{{interface_link_text}}]({{interface_link}}) | | 146 | +| {{interface_name}} | {{interface_summary}} | 《[{{interface_link_text}}]({{interface_link}})》 | |
| 147 | 147 | ||
| 148 | > **注释：** | 148 | > **注释：** |
| 149 | > 只做索引表：命令/API/配置协议名、一句用途简述、权威文档链接。参数细节写在被链接文档里。工具类流程建议保留本章节。 | 149 | > 只做索引表：命令/API/配置协议名、一句用途简述、权威文档链接。参数细节写在被链接文档里。工具类流程建议保留本章节。 |
| @@ -1,6 +1,6 @@ | |||
| 1 | # 通用案例校验清单 | 1 | # 通用案例校验清单 |
| 2 | 2 | ||
| 3 | -> 用于校验基于[《通用案例模板》](03_general_case_template.md)新建或整改的文档，并核对与关联流程指南的衔接关系。通用校验条目与校验机制（使用说明 / 校验执行 / 豁免机制）见[《公共校验清单》](00_common_checklist.md)；以下为通用案例类型专属校验条目，本清单条目均为 ERROR（必须满足）。 | 3 | +> 用于校验基于《[通用案例模板](03_general_case_template.md)》新建或整改的文档，并核对与关联流程指南的衔接关系。通用校验条目与校验机制（使用说明 / 校验执行 / 豁免机制）见《[公共校验清单](00_common_checklist.md)》；以下为通用案例类型专属校验条目，本清单条目均为 ERROR（必须满足）。 |
| 4 | 4 | ||
| 5 | ## 1. 校验条目 | 5 | ## 1. 校验条目 |
| 6 | 6 | ||
| @@ -22,7 +22,7 @@ | |||
| 22 | | GC-012 | 分项与表头 | 输入与交付件分项列出，表头含：类型、名称、来源或保存位置、格式或约束、验收方式。 | 补充表头与分项 | | 22 | | GC-012 | 分项与表头 | 输入与交付件分项列出，表头含：类型、名称、来源或保存位置、格式或约束、验收方式。 | 补充表头与分项 | |
| 23 | | GC-013 | 来源可定位 | 每项来源或保存位置可定位（路径、链接或明确获取方式）。 | 补充来源 | | 23 | | GC-013 | 来源可定位 | 每项来源或保存位置可定位（路径、链接或明确获取方式）。 | 补充来源 | |
| 24 | | GC-014 | 格式或约束 | 每项「格式或约束」已填写且可核对。 | 补充格式或约束 | | 24 | | GC-014 | 格式或约束 | 每项「格式或约束」已填写且可核对。 | 补充格式或约束 | |
| 25 | -| GC-015 | 验收方式 | 每项具备可验证的验收方式；量化权重类交付件含 md5 或 safetensors 比对结果（或等价可核对方式）。 | 补充验收方式或比对结果 | | 25 | +| GC-015 | 验收方式 | 每项具备可验证的验收方式；量化权重类交付件含 MD5 或 safetensors 比对结果（或等价可核对方式）。 | 补充验收方式或比对结果 | |
| 26 | | GC-016 | 实际取值 | 填写的是本案例实际取值，而非未落地的占位说明或模板示例原文。 | 替换为实际取值 | | 26 | | GC-016 | 实际取值 | 填写的是本案例实际取值，而非未落地的占位说明或模板示例原文。 | 替换为实际取值 | |
| 27 | | GC-017 | 步骤完整性 | 已保留步骤均包含：目标、输入、操作、输出、记录、下一步。 | 补充步骤要素 | | 27 | | GC-017 | 步骤完整性 | 已保留步骤均包含：目标、输入、操作、输出、记录、下一步。 | 补充步骤要素 | |
| 28 | | GC-018 | 操作可执行 | 操作具体可执行；关键命令或配置以代码块给出。 | 补充命令或代码块 | | 28 | | GC-018 | 操作可执行 | 操作具体可执行；关键命令或配置以代码块给出。 | 补充命令或代码块 | |
| @@ -38,6 +38,6 @@ | |||
| 38 | | GC-028 | 章节一致性 | 未选用的可选章节已删除；背景声明覆盖的步骤在正文均有对应。 | 删除未用章节或补充正文 | | 38 | | GC-028 | 章节一致性 | 未选用的可选章节已删除；背景声明覆盖的步骤在正文均有对应。 | 删除未用章节或补充正文 | |
| 39 | | GC-029 | 关联流程存在 | 关联的流程文档存在，且案例场景落在该流程适用范围内。 | 修正关联或补充流程 | | 39 | | GC-029 | 关联流程存在 | 关联的流程文档存在，且案例场景落在该流程适用范围内。 | 修正关联或补充流程 | |
| 40 | | GC-030 | 交付件不冲突 | 案例交付件与关联流程要求的关键交付件不冲突。 | 调整交付件 | | 40 | | GC-030 | 交付件不冲突 | 案例交付件与关联流程要求的关键交付件不冲突。 | 调整交付件 | |
| 41 | -| GC-031 | 入口链接 | 若流程「案例列表」需挂接本案例，入口链接已更新或已提跟踪项。 | 更新入口或登记跟踪项 | | 41 | +| GC-031 | 入口链接 | 若流程「案例列表」需挂接本案例，入口链接已更新或已登记跟踪项。 | 更新入口或登记跟踪项 | |
| 42 | | GC-032 | 路径泛化 | 路径已泛化或使用环境变量约定，他人可按说明复现。 | 泛化路径 | | 42 | | GC-032 | 路径泛化 | 路径已泛化或使用环境变量约定，他人可按说明复现。 | 泛化路径 | |
| 43 | | GC-033 | 结论一致 | 结论表述与「关键结果汇总」及交付件验收数据一致，未夸大未验证收益。 | 修正结论 | | 43 | | GC-033 | 结论一致 | 结论表述与「关键结果汇总」及交付件验收数据一致，未夸大未验证收益。 | 修正结论 | |
| @@ -8,7 +8,7 @@ | |||
| 8 | 8 | ||
| 9 | > **注释：** 说明本次目标、场景，以及实际覆盖的流程步骤名称。 | 9 | > **注释：** 说明本次目标、场景，以及实际覆盖的流程步骤名称。 |
| 10 | 10 | ||
| 11 | -**关联流程**：[{{related_workflow_title}}]({{related_workflow_link}}) | 11 | +**关联流程**：《[{{related_workflow_title}}]({{related_workflow_link}})》 |
| 12 | 12 | ||
| 13 | > **注释：** 链接至对应流程指南，不在此重复流程规范。 | 13 | > **注释：** 链接至对应流程指南，不在此重复流程规范。 |
| 14 | 14 | ||
Mdocs/zh/contributing/development_guide/docs_standards/04_quantization_config_document_checklist.md+13-13
| @@ -1,6 +1,6 @@ | |||
| 1 | # 量化配置文档校验清单 | 1 | # 量化配置文档校验清单 |
| 2 | 2 | ||
| 3 | -> 用于校验基于[《量化配置文档模板》](04_quantization_config_document_template.md)新建或整改的文档，适用于 `ModelslimV1ServiceConfig`、`MultimodalSDServiceConfig`、`MultimodalVLMServiceConfig` 及其引用配置。通用校验条目与校验机制（使用说明 / 校验执行 / 豁免机制）见[《公共校验清单》](00_common_checklist.md)；以下为量化配置文档类型专属校验条目，按严重级别分表。 | 3 | +> 用于校验基于《[量化配置文档模板](04_quantization_config_document_template.md)》新建或整改的文档，适用于 `ModelslimV1ServiceConfig`、`MultimodalSDServiceConfig`、`MultimodalVLMServiceConfig` 及其引用配置。通用校验条目与校验机制（使用说明 / 校验执行 / 豁免机制）见《[公共校验清单](00_common_checklist.md)》；以下为量化配置文档类型专属校验条目，按严重级别分表。 |
| 4 | 4 | ||
| 5 | ## 1. 校验条目 | 5 | ## 1. 校验条目 |
| 6 | 6 | ||
| @@ -8,20 +8,20 @@ | |||
| 8 | 8 | ||
| 9 | | 编号 | 校验条目 | 判定条件 | 处理建议 | | 9 | | 编号 | 校验条目 | 判定条件 | 处理建议 | |
| 10 | | :--- | :--- | :--- | :--- | | 10 | | :--- | :--- | :--- | :--- | |
| 11 | -| Q01 | 配置概述元信息 | “配置概述”元信息表格包含配置类和源码链接，两者均可在目标版本源码中定位。 | 补齐缺失字段，修正失效链接 | | 11 | +| QE-01 | 配置概述元信息 | “配置概述”元信息表格包含配置类和源码链接，两者均可在目标版本源码中定位。 | 补齐缺失字段，修正失效链接 | |
| 12 | -| Q03 | 参数列表完整性 | “参数列表”覆盖配置类直接定义及通过继承对外开放的全部字段；字段使用从配置根节点开始的完整路径。 | 补齐缺失字段，删除不存在字段，修正路径 | | 12 | +| QE-02 | 参数列表完整性 | “参数列表”覆盖配置类直接定义及通过继承对外开放的全部字段；字段使用从配置根节点开始的完整路径。 | 补齐缺失字段，删除不存在字段，修正路径 | |
| 13 | -| Q04 | 字段属性一致 | 每个字段的类型、必选/可选状态、默认值与模型定义及运行时校验一致；枚举值、边界、格式约束描述完整。 | 修正不一致的字段属性 | | 13 | +| QE-03 | 字段属性一致 | 每个字段的类型、必选/可选状态、默认值与模型定义及运行时校验一致；枚举值、边界、格式约束描述完整。 | 修正不一致的字段属性 | |
| 14 | -| Q06 | 引用的配置 | “引用的配置”覆盖本配置使用的全部嵌套配置，链接指向字段说明或独立配置文档；存在联合类型子配置时，已填写“适用字段”“子配置类别”“`type` 或辨识值”列；普通引用这三列填写“-”。子配置类型较多（超过5个）时，允许使用汇总行 + 子配置索引表的模式，汇总行的“`type` 或辨识值”填写“见下方索引”并链接到索引表。 | 补齐遗漏引用，修正链接目标，补充子配置列；子类型过多时改用索引表模式 | | 14 | +| QE-04 | 引用的配置 | “引用的配置”覆盖本配置使用的全部嵌套配置，链接指向字段说明或独立配置文档；存在联合类型子配置时，已填写“适用字段”“子配置类别”“`type` 或辨识值”列；普通引用这三列填写“-”。子配置类型较多（超过5个）时，允许使用汇总行 + 子配置索引表的模式，汇总行的“`type` 或辨识值”填写“见下方索引”并链接到索引表。 | 补齐遗漏引用，修正链接目标，补充子配置列；子类型过多时改用索引表模式 | |
| 15 | -| Q08 | 完整配置参考 | “完整配置参考”提供语法正确的 YAML，配置放在实际的完整字段路径中，可被配置加载入口成功解析。 | 修正 YAML 语法或路径层级 | | 15 | +| QE-05 | 完整配置参考 | “完整配置参考”提供语法正确的 YAML，配置放在实际的完整字段路径中，可被配置加载入口成功解析。 | 修正 YAML 语法或路径层级 | |
| 16 | 16 | ||
| 17 | ### 1.2 WARN（建议满足） | 17 | ### 1.2 WARN（建议满足） |
| 18 | 18 | ||
| 19 | | 编号 | 校验条目 | 判定条件 | 处理建议 | | 19 | | 编号 | 校验条目 | 判定条件 | 处理建议 | |
| 20 | | :--- | :--- | :--- | :--- | | 20 | | :--- | :--- | :--- | :--- | |
| 21 | -| Q02 | 配置概述内容 | “配置概述”明确说明控制的量化阶段、适用模型或场景，以及在完整配置中的位置。 | 补充或修正配置概述 | | 21 | +| QW-01 | 配置概述内容 | “配置概述”明确说明控制的量化阶段、适用模型或场景，以及在完整配置中的位置。 | 补充或修正配置概述 | |
| 22 | -| Q05 | 配置约束 | “配置约束”仅描述可由解析器、校验器或加载逻辑判断的规则（互斥、依赖、优先级、回退等）；没有额外约束时已明确填写“无”。 | 移除无法校验的实践性约束（移至“注意事项”），或填写“无” | | 22 | +| QW-02 | 配置约束 | “配置约束”仅描述可由解析器、校验器或加载逻辑判断的规则（互斥、依赖、优先级、回退等）；没有额外约束时已明确填写“无”。 | 移除无法校验的实践性约束（移至“注意事项”），或填写“无” | |
| 23 | -| Q07 | 被引用的配置 | “被引用的配置”覆盖所有已知上层入口，注明引用位置和适用场景；没有引用方时已用“无。”替代表格。 | 补充引用方信息，或填写“无。” | | 23 | +| QW-03 | 被引用的配置 | “被引用的配置”覆盖所有已知上层入口，注明引用位置和适用场景；没有引用方时已用“无。”替代表格。 | 补充引用方信息，或填写“无。” | |
| 24 | -| Q09 | 示例值约束 | “完整配置参考”示例值满足参数约束，与参数列表一致；复杂嵌套配置通过 `type` 标明类型，未使用省略号代替。 | 修正不一致的示例值，展开省略部分 | | 24 | +| QW-04 | 示例值约束 | “完整配置参考”示例值满足参数约束，与参数列表一致；复杂嵌套配置通过 `type` 标明类型，未使用省略号代替。 | 修正不一致的示例值，展开省略部分 | |
| 25 | -| Q10 | 兼容性与迁移 | “兼容性与迁移”仅在存在版本差异时保留；废弃字段已说明替代方案和迁移方式。 | 删除不适用章节，或补充迁移说明 | | 25 | +| QW-05 | 兼容性与迁移 | “兼容性与迁移”仅在存在版本差异时保留；废弃字段已说明替代方案和迁移方式。 | 删除不适用章节，或补充迁移说明 | |
| 26 | -| Q11 | 注意事项 | “注意事项”仅描述运行时实践问题（性能、精度、显存等），不重复“配置约束”中已有的校验规则。 | 将可校验规则移至“配置约束”，保留实践问题 | | 26 | +| QW-06 | 注意事项 | “注意事项”仅描述运行时实践问题（性能、精度、显存等），不重复“配置约束”中已有的校验规则。 | 将可校验规则移至“配置约束”，保留实践问题 | |
| 27 | -| Q12 | 标题序号 | 文档标题已按模板顺序使用序号（如 1. 配置概述、2. 参数列表、3. 配置约束 等）。 | 补充或修正章节标题序号 | | 27 | +| QW-07 | 标题序号 | 文档标题已按模板顺序使用序号（如 1. 配置概述、2. 参数列表、3. 配置约束 等）。 | 补充或修正章节标题序号 | |
Mdocs/zh/contributing/development_guide/docs_standards/04_quantization_config_document_template.md+2-2
| @@ -40,7 +40,7 @@ | |||
| 40 | 40 | ||
| 41 | | 字段路径 | 配置名称 | 引用关系 | 适用字段 | 子配置类别 | `type` 或辨识值 | 配置文档 | | 41 | | 字段路径 | 配置名称 | 引用关系 | 适用字段 | 子配置类别 | `type` 或辨识值 | 配置文档 | |
| 42 | |----------|----------|----------|----------|------------|-----------------|----------| | 42 | |----------|----------|----------|----------|------------|-----------------|----------| |
| 43 | -| `{{ referenced_field_path }}` | `{{ referenced_config_name }}` | {{ reference_relationship }} | {{ union_field_path }} | {{ sub_config_category }} | `{{ sub_config_type }}` | [{{ referenced_document_name }}]({{ referenced_document_link }}) | | 43 | +| `{{ referenced_field_path }}` | `{{ referenced_config_name }}` | {{ reference_relationship }} | {{ union_field_path }} | {{ sub_config_category }} | `{{ sub_config_type }}` | 《[{{ referenced_document_name }}]({{ referenced_document_link }})》 | |
| 44 | 44 | ||
| 45 | ## 5. 被引用的配置 | 45 | ## 5. 被引用的配置 |
| 46 | 46 | ||
| @@ -48,7 +48,7 @@ | |||
| 48 | 48 | ||
| 49 | | 引用方 | 引用位置 | 适用场景 | 引用方文档 | | 49 | | 引用方 | 引用位置 | 适用场景 | 引用方文档 | |
| 50 | |--------|----------|----------|------------| | 50 | |--------|----------|----------|------------| |
| 51 | -| `{{ parent_config_name }}` | `{{ parent_reference_path }}` | {{ parent_reference_scenario }} | [{{ parent_document_name }}]({{ parent_document_link }}) | | 51 | +| `{{ parent_config_name }}` | `{{ parent_reference_path }}` | {{ parent_reference_scenario }} | 《[{{ parent_document_name }}]({{ parent_document_link }})》 | |
| 52 | 52 | ||
| 53 | ## 6. 完整配置参考 | 53 | ## 6. 完整配置参考 |
| 54 | 54 | ||
| @@ -1,6 +1,6 @@ | |||
| 1 | # 命令行 API 文档校验清单 | 1 | # 命令行 API 文档校验清单 |
| 2 | 2 | ||
| 3 | -> 用于校验基于[《命令行 API 文档模板》](05_cli_api_contract_template.md)新建或整改的文档。通用校验条目与校验机制（使用说明 / 校验执行 / 豁免机制）见[《公共校验清单》](00_common_checklist.md)；以下为命令行 API 文档类型专属校验条目，按严重级别分表。 | 3 | +> 用于校验基于《[命令行 API 文档模板](05_cli_api_contract_template.md)》新建或整改的文档。通用校验条目与校验机制（使用说明 / 校验执行 / 豁免机制）见《[公共校验清单](00_common_checklist.md)》；以下为命令行 API 文档类型专属校验条目，按严重级别分表。 |
| 4 | 4 | ||
| 5 | ## 1. 校验条目 | 5 | ## 1. 校验条目 |
| 6 | 6 | ||
| @@ -8,20 +8,20 @@ | |||
| 8 | 8 | ||
| 9 | | 编号 | 校验条目 | 判定条件 | 处理建议 | | 9 | | 编号 | 校验条目 | 判定条件 | 处理建议 | |
| 10 | | :--- | :--- | :--- | :--- | | 10 | | :--- | :--- | :--- | :--- | |
| 11 | -| C01 | 命令名称一致 | 文档标题中的命令名称与实际可执行命令一致。 | 修正标题中的命令名称 | | 11 | +| LE-01 | 命令名称一致 | 文档标题中的命令名称与实际可执行命令一致。 | 修正标题中的命令名称 | |
| 12 | -| C02 | 功能说明 | “功能说明”已填写，准确描述命令的能力、适用场景和边界，非占位符或空。 | 补充或修正功能说明 | | 12 | +| LE-02 | 功能说明 | “功能说明”已填写，准确描述命令的能力、适用场景和边界，非占位符或空。 | 补充或修正功能说明 | |
| 13 | -| C03 | 命令格式 | “命令格式”给出完整的语法摘要，正确使用方括号（可选）和尖括号（需替换的值），未被表述为可直接复制的命令。 | 修正语法摘要，确保与 `--help` 一致 | | 13 | +| LE-03 | 命令格式 | “命令格式”给出完整的语法摘要，正确使用方括号（可选）和尖括号（需替换的值），未被表述为可直接复制的命令。 | 修正语法摘要，确保与 `--help` 一致 | |
| 14 | -| C04 | 参数列表完整性 | “参数列表”覆盖 `--help` 和实现代码中对用户开放的全部参数，无遗漏或多余项。 | 补齐缺失参数，删除不存在或内部参数 | | 14 | +| LE-04 | 参数列表完整性 | “参数列表”覆盖 `--help` 和实现代码中对用户开放的全部参数，无遗漏或多余项。 | 补齐缺失参数，删除不存在或内部参数 | |
| 15 | -| C05 | 参数属性一致 | 每个参数的名称、别名、类型、必选/可选状态、默认值与实现一致；布尔参数明确区分无值开关和显式值传入方式。 | 修正不一致的字段 | | 15 | +| LE-05 | 参数属性一致 | 每个参数的名称、别名、类型、必选/可选状态、默认值与实现一致；布尔参数明确区分无值开关和显式值传入方式。 | 修正不一致的字段 | |
| 16 | 16 | ||
| 17 | ### 1.2 WARN（建议满足） | 17 | ### 1.2 WARN（建议满足） |
| 18 | 18 | ||
| 19 | | 编号 | 校验条目 | 判定条件 | 处理建议 | | 19 | | 编号 | 校验条目 | 判定条件 | 处理建议 | |
| 20 | | :--- | :--- | :--- | :--- | | 20 | | :--- | :--- | :--- | :--- | |
| 21 | -| C06 | 参数关系 | “参数关系”已说明互斥、依赖、优先级等规则；没有参数关系时已明确填写“无”。 | 补充参数关系或填写“无” | | 21 | +| LW-01 | 参数关系 | “参数关系”已说明互斥、依赖、优先级等规则；没有参数关系时已明确填写“无”。 | 补充参数关系或填写“无” | |
| 22 | -| C07 | 引用的配置 | “引用的配置”仅在命令通过参数加载 YAML 配置或量化方案时保留；链接指向配置文档而非仅指向源码。 | 删除不适用章节，或修正链接目标 | | 22 | +| LW-02 | 引用的配置 | “引用的配置”仅在命令通过参数加载 YAML 配置或量化方案时保留；链接指向配置文档而非仅指向源码。 | 删除不适用章节，或修正链接目标 | |
| 23 | -| C08 | 环境变量 | “环境变量”仅在存在命令专属环境变量时保留；全局环境变量未重复说明；不包含真实凭据。 | 删除不适用章节，或移除敏感信息 | | 23 | +| LW-03 | 环境变量 | “环境变量”仅在存在命令专属环境变量时保留；全局环境变量未重复说明；不包含真实凭据。 | 删除不适用章节，或移除敏感信息 | |
| 24 | -| C09 | 使用示例 | “使用示例”存在时，第一条为最小可跑场景；示例使用大写 shell 变量代替具体值；不包含真实密钥或内部地址。 | 精简示例参数，替换敏感值为变量 | | 24 | +| LW-04 | 使用示例 | “使用示例”存在时，第一条为最小可运行场景；示例使用大写 shell 变量代替具体值；不包含真实密钥或内部地址。 | 精简示例参数，替换敏感值为变量 | |
| 25 | -| C10 | 退出码与异常处理 | “退出码与异常处理”保持轻量；未定义稳定退出码时仅说明 `0`/非 `0` 含义。 | 精简或补充退出码说明 | | 25 | +| LW-05 | 退出码与异常处理 | “退出码与异常处理”保持轻量；未定义稳定退出码时仅说明 `0`/非 `0` 含义。 | 精简或补充退出码说明 | |
| 26 | -| C11 | 破坏性变更 | 已识别相对上一稳定版本的破坏性变更（参数增删、默认值变化、行为变化等）。 | 在文档中补充变更说明 | | 26 | +| LW-06 | 破坏性变更 | 已识别相对上一稳定版本的破坏性变更（参数增删、默认值变化、行为变化等）。 | 在文档中补充变更说明 | |
| 27 | -| C12 | 标题序号 | 文档标题已按模板顺序使用序号（如 1. 功能说明、2. 命令格式、3. 参数列表 等）。 | 补充或修正章节标题序号 | | 27 | +| LW-07 | 标题序号 | 文档标题已按模板顺序使用序号（如 1. 功能说明、2. 命令格式、3. 参数列表 等）。 | 补充或修正章节标题序号 | |
| @@ -47,7 +47,7 @@ | |||
| 47 | 47 | ||
| 48 | | 关联参数 | 配置名称 | 引用关系 | 配置文档 | | 48 | | 关联参数 | 配置名称 | 引用关系 | 配置文档 | |
| 49 | |----------|----------|----------|----------| | 49 | |----------|----------|----------|----------| |
| 50 | -| `--{{ referenced_param_name }}` | `{{ referenced_config_name }}` | {{ reference_relationship }} | [{{ referenced_document_name }}]({{ referenced_document_link }}) | | 50 | +| `--{{ referenced_param_name }}` | `{{ referenced_config_name }}` | {{ reference_relationship }} | 《[{{ referenced_document_name }}]({{ referenced_document_link }})》 | |
| 51 | 51 | ||
| 52 | ## 6. [OPTIONAL] 环境变量 | 52 | ## 6. [OPTIONAL] 环境变量 |
| 53 | 53 | ||
| @@ -59,7 +59,7 @@ | |||
| 59 | 59 | ||
| 60 | ## 7. [OPTIONAL] 使用示例 | 60 | ## 7. [OPTIONAL] 使用示例 |
| 61 | 61 | ||
| 62 | -> **注释：** 仅当需要展示典型场景或参数组合时保留本节。第一条示例应为最小可跑场景，只包含完成核心功能所需的最少参数；后续示例用于展示常见参数组合或高级场景。示例必须可复制，路径、模型名等变量使用大写 shell 变量，并在代码块后解释变量和预期结果。不得包含真实密钥或内部地址。 | 62 | +> **注释：** 仅当需要展示典型场景或参数组合时保留本节。第一条示例应为最小可运行场景，只包含完成核心功能所需的最少参数；后续示例用于展示常见参数组合或高级场景。示例必须可复制，路径、模型名等变量使用大写 shell 变量，并在代码块后解释变量和预期结果。不得包含真实密钥或内部地址。 |
| 63 | 63 | ||
| 64 | ### {{ example_scenario_name }} | 64 | ### {{ example_scenario_name }} |
| 65 | 65 | ||
| @@ -42,15 +42,15 @@ | |||
| 42 | 42 | ||
| 43 | | 类型 | 定位 | 模板 | 校验清单 | | 43 | | 类型 | 定位 | 模板 | 校验清单 | |
| 44 | | --- | --- | --- | --- | | 44 | | --- | --- | --- | --- | |
| 45 | -| 算法词条 | 陈述性知识：是什么 / 原理 / 性质 / 关联 | [01_quantization_glossary_template](./01_quantization_glossary_template.md) | [01_quantization_glossary_checklist](./01_quantization_glossary_checklist.md) | | 45 | +| 术语词条 | 陈述性知识：是什么 / 原理 / 性质 / 关联 | 《[术语词条模板](./01_term_glossary_template.md)》 | 《[术语词条校验清单](./01_term_glossary_checklist.md)》 | |
| 46 | -| 流程指南 | 过程性知识：适用范围 / 输入交付件 / 操作步骤 | [02_process_guide_template](./02_process_guide_template.md) | [02_process_guide_checklist](./02_process_guide_checklist.md) | | 46 | +| 流程指南 | 过程性知识：适用范围 / 输入交付件 / 操作步骤 | 《[流程指南模板](./02_process_guide_template.md)》 | 《[流程指南校验清单](./02_process_guide_checklist.md)》 | |
| 47 | -| 案例参考 | 实践案例：背景 / 环境 / 步骤 / 结果 / 经验 | [03_general_case_template](./03_general_case_template.md) | [03_general_case_checklist](./03_general_case_checklist.md) | | 47 | +| 案例参考 | 实践案例：背景 / 环境 / 步骤 / 结果 / 经验 | 《[通用案例模板](./03_general_case_template.md)》 | 《[通用案例校验清单](./03_general_case_checklist.md)》 | |
| 48 | -| 量化配置文档 | 配置接口参考 | [04_quantization_config_document_template](./04_quantization_config_document_template.md) | [04_quantization_config_document_checklist](./04_quantization_config_document_checklist.md) | | 48 | +| 量化配置文档 | 配置接口参考 | 《[量化配置文档模板](./04_quantization_config_document_template.md)》 | 《[量化配置文档校验清单](./04_quantization_config_document_checklist.md)》 | |
| 49 | -| CLI文档 | 命令与接口契约 | [05_cli_api_contract_template](./05_cli_api_contract_template.md) | [05_cli_api_contract_checklist](./05_cli_api_contract_checklist.md) | | 49 | +| CLI文档 | 命令与接口契约 | 《[命令行 API 文档模板](./05_cli_api_contract_template.md)》 | 《[命令行 API 文档校验清单](./05_cli_api_contract_checklist.md)》 | |
| 50 | 50 | ||
| 51 | > **受众与详略**：使用指南（流程指南）面向入门者，以详细步骤引导选择参数、填写配置并执行；API / 配置文档面向高阶用户快速检索查阅，仅需明确命令名、参数与取值等参考信息，不展开步骤讲解。 | 51 | > **受众与详略**：使用指南（流程指南）面向入门者，以详细步骤引导选择参数、填写配置并执行；API / 配置文档面向高阶用户快速检索查阅，仅需明确命令名、参数与取值等参考信息，不展开步骤讲解。 |
| 52 | 52 | ||
| 53 | -**模板体系外文档**：安装指南、快速入门、FAQ、版本说明、法律声明、各目录 README 等，不套模板，遵循[第4.1节](#41-通用编写要求)，并至少满足[《公共校验清单》](00_common_checklist.md)的 ERROR 条目（占位符残留、模板注释残留、敏感信息、标题）。 | 53 | +**模板体系外文档**：安装指南、快速入门、FAQ、版本说明、法律声明、各目录 README 等，不套模板，遵循[第4.1节](#41-通用编写要求)，并至少满足《[公共校验清单](00_common_checklist.md)》的 ERROR 条目（占位符残留、模板注释残留、敏感信息、标题）。 |
| 54 | 54 | ||
| 55 | ### 2.3 文档类型选择 | 55 | ### 2.3 文档类型选择 |
| 56 | 56 | ||
| @@ -58,7 +58,7 @@ | |||
| 58 | 58 | ||
| 59 | | 内容特征 | 文档类型 | | 59 | | 内容特征 | 文档类型 | |
| 60 | | --- | --- | | 60 | | --- | --- | |
| 61 | -| 概念或算法的定义、原理与性质说明 | 算法词条 | | 61 | +| 概念或算法的定义、原理与性质说明 | 术语词条 | |
| 62 | | 任务的操作步骤与执行流程说明 | 流程指南（含使用指南） | | 62 | | 任务的操作步骤与执行流程说明 | 流程指南（含使用指南） | |
| 63 | | 实践活动的背景、过程、结果与经验记录 | 案例参考 | | 63 | | 实践活动的背景、过程、结果与经验记录 | 案例参考 | |
| 64 | | 配置类接口的字段、约束与取值说明 | 量化配置文档 | | 64 | | 配置类接口的字段、约束与取值说明 | 量化配置文档 | |
| @@ -95,9 +95,9 @@ docs/zh/ | |||
| 95 | 95 | ||
| 96 | ### 4.1 通用编写要求 | 96 | ### 4.1 通用编写要求 |
| 97 | 97 | ||
| 98 | -面向全部文档。本节要求与[《公共校验清单》](00_common_checklist.md)的可校验条目对应，编写与校验时冲突以校验清单为准： | 98 | +面向全部文档。本节要求与《[公共校验清单](00_common_checklist.md)》的可校验条目对应，编写与校验时冲突以校验清单为准： |
| 99 | 99 | ||
| 100 | -- **占位符**：不残留模板占位符 `{{ ... }}`（对应《公共校验清单》CE-01）。 | 100 | +- **占位符**：不残留模板占位符 `{{ ... }}`（对应《[公共校验清单](./00_common_checklist.md)》CE-01）。 |
| 101 | - **模板注释**：不残留模板注释（以 `> **注释：**` 开头、含“将 xxx 替换为”“必填”“选填”等指导性文字，对应 CE-02）。 | 101 | - **模板注释**：不残留模板注释（以 `> **注释：**` 开头、含“将 xxx 替换为”“必填”“选填”等指导性文字，对应 CE-02）。 |
| 102 | - **标题**：每个文档仅一个 `#` 一级标题；标题层级 `##` → `###` 逐级递进，不跳级（对应 CE-04）。 | 102 | - **标题**：每个文档仅一个 `#` 一级标题；标题层级 `##` → `###` 逐级递进，不跳级（对应 CE-04）。 |
| 103 | - **语言与句式**：面向用户的中文技术文档；首次出现缩写给出全称；句子成分完整、语义明确。 | 103 | - **语言与句式**：面向用户的中文技术文档；首次出现缩写给出全称；句子成分完整、语义明确。 |
| @@ -105,9 +105,9 @@ docs/zh/ | |||
| 105 | - **代码块**：标注语言；命令与路径使用环境变量泛化（对应 CW-02）。 | 105 | - **代码块**：标注语言；命令与路径使用环境变量泛化（对应 CW-02）。 |
| 106 | - **公式**：LaTeX 语法，行内 `$...$`、块级 `$$...$$`；公式中变量须在公式下方列表说明。 | 106 | - **公式**：LaTeX 语法，行内 `$...$`、块级 `$$...$$`；公式中变量须在公式下方列表说明。 |
| 107 | - **图片**：放入文档同级 `figures/` 目录，使用相对路径引用，并控制显示尺寸。 | 107 | - **图片**：放入文档同级 `figures/` 目录，使用相对路径引用，并控制显示尺寸。 |
| 108 | -- **链接**：内部链接使用相对路径，锚文本使用目标文档标题（对应 CW-02）。 | 108 | +- **链接**：内部链接使用相对路径，锚文本为 `《目标文档标题》`（书名号内为目标文档正式标题，非文件路径名；对应《[公共校验清单](./00_common_checklist.md)》CE-05、CW-02）。 |
| 109 | -- **书名号**：正文引用文档标题时以《》括起（对应《公共校验清单》CE-05）。 | 109 | +- **书名号**：正文引用文档标题时以《》括起（对应《[公共校验清单](./00_common_checklist.md)》CE-05）。 |
| 110 | -- **数字单位**：数字与量词/单位间不留空格（对应《公共校验清单》CE-06）。 | 110 | +- **数字单位**：数字与量词/单位间不留空格（对应《[公共校验清单](./00_common_checklist.md)》CE-06）。 |
| 111 | - **敏感信息**：不得包含密钥、令牌、内网地址、个人路径（对应 CE-03）。 | 111 | - **敏感信息**：不得包含密钥、令牌、内网地址、个人路径（对应 CE-03）。 |
| 112 | 112 | ||
| 113 | ### 4.2 分类编写要求 | 113 | ### 4.2 分类编写要求 |
| @@ -120,14 +120,14 @@ docs/zh/ | |||
| 120 | 120 | ||
| 121 | ### 5.1 业务流程图 | 121 | ### 5.1 业务流程图 |
| 122 | 122 | ||
| 123 | -业务流程图是一个**嵌套图**：每个节点都是流程文档，且**业务作业流程本身也是一篇流程文档**。所有流程文档均遵循[《流程指南模板》](./02_process_guide_template.md)。 | 123 | +业务流程图是一个**嵌套图**：每个节点都是流程文档，且**业务作业流程本身也是一篇流程文档**。所有流程文档均遵循《[流程指南模板](./02_process_guide_template.md)》。 |
| 124 | 124 | ||
| 125 | **规则** | 125 | **规则** |
| 126 | 126 | ||
| 127 | -1. **节点即流程文档**：流程图的每个节点都是一篇流程文档——业务作业流程、子流程、工具使用流程——均遵循流程指南模板。 | 127 | +1. **节点即流程文档**：流程图的每个节点都是一篇流程文档——业务作业流程、子流程、工具使用流程——均遵循《[流程指南模板](./02_process_guide_template.md)》。 |
| 128 | 2. **业务作业流程是一篇文档**：业务作业流程是独立的流程指南文档，而非虚拟分组；其子节点是工具使用流程。 | 128 | 2. **业务作业流程是一篇文档**：业务作业流程是独立的流程指南文档，而非虚拟分组；其子节点是工具使用流程。 |
| 129 | 3. **子流程以链接引用**：业务作业流程通过「操作步骤」章节以超链接引用其工具使用流程（子流程）文档；工具使用流程同样遵循流程模板。 | 129 | 3. **子流程以链接引用**：业务作业流程通过「操作步骤」章节以超链接引用其工具使用流程（子流程）文档；工具使用流程同样遵循流程模板。 |
| 130 | -4. **非流程内容不入图**：术语（词条）、API / 配置文档、案例不属于流程图节点，由流程文档通过「术语」「接口文档列表」「案例列表」章节（见流程指南模板）以链接形式引用。 | 130 | +4. **非流程内容不入图**：术语（词条）、API / 配置文档、案例不属于流程图节点，由流程文档通过「术语」「接口文档列表」「案例列表」章节（见《[流程指南模板](./02_process_guide_template.md)》）以链接形式引用。 |
| 131 | 5. **链接必须可解析**：流程图中每个节点的链接指向仓库内真实存在的流程文档；规划中尚未发布的子流程不放入流程图。 | 131 | 5. **链接必须可解析**：流程图中每个节点的链接指向仓库内真实存在的流程文档；规划中尚未发布的子流程不放入流程图。 |
| 132 | 132 | ||
| 133 | ### 5.2 知识图谱 | 133 | ### 5.2 知识图谱 |
| @@ -136,7 +136,7 @@ docs/zh/ | |||
| 136 | 136 | ||
| 137 | - 每个词条在 `## 关联词条` 中以超链接列出相关词条，并标注关系类型。 | 137 | - 每个词条在 `## 关联词条` 中以超链接列出相关词条，并标注关系类型。 |
| 138 | - 每个词条在 `## 关联流程` 中链接到相关流程 / 使用指南。 | 138 | - 每个词条在 `## 关联流程` 中链接到相关流程 / 使用指南。 |
| 139 | -- 词条按所属类别组织；关系类型与分类取值见词条模板。 | 139 | +- 词条按所属类别组织；关系类型与分类取值见《[术语词条模板](./01_term_glossary_template.md)》。 |
| 140 | - 一致性要求：每个词条至少被其他1个词条反向引用（入度 ≥1），整体构成弱连通图；词条间不得孤立。链接必须可解析，规划中尚未创建的词条不放入知识图谱。 | 140 | - 一致性要求：每个词条至少被其他1个词条反向引用（入度 ≥1），整体构成弱连通图；词条间不得孤立。链接必须可解析，规划中尚未创建的词条不放入知识图谱。 |
| 141 | - 与业务流程图的衔接：词条是知识节点，流程 / 使用指南是使用节点，API 文档是接口节点；业务流程图横向串联它们，知识图谱纵向连接词条，两者互为补充。 | 141 | - 与业务流程图的衔接：词条是知识节点，流程 / 使用指南是使用节点，API 文档是接口节点；业务流程图横向串联它们，知识图谱纵向连接词条，两者互为补充。 |
| 142 | 142 | ||
| @@ -173,3 +173,6 @@ docs/zh/ | |||
| 173 | | 日期 | 版本 | 变更说明 | | 173 | | 日期 | 版本 | 变更说明 | |
| 174 | | --- | --- | --- | | 174 | | --- | --- | --- | |
| 175 | | 2026-08-05 | v1.0 | 首次发布。 | | 175 | | 2026-08-05 | v1.0 | 首次发布。 | |
| 176 | +| 2026-08-07 | v1.1 | 词条文档类型更名为「术语词条」，模板与校验清单文件更名 term_glossary；正文书名号与失效示例修正。 | | ||
| 177 | +| 2026-08-12 | v1.2 | 书名号标题引用补链接（《流程指南模板》《术语词条模板》《公共校验清单》），与 CE-05/CW-02 对齐。 | | ||
| 178 | +| 2026-08-12 | v1.3 | 书名号锚文本统一为《[标题](链接)》形式，CE-05 示例收敛为单一规范形式。 | | ||
| @@ -14,7 +14,7 @@ metadata: | |||
| 14 | 14 | ||
| 15 | ## 概述 | 15 | ## 概述 |
| 16 | 16 | ||
| 17 | -本 skill 以[资料规范](../../docs/zh/contributing/development_guide/docs_standards/README.md)为唯一依据，负责 msModelSlim `docs/` 资料的文件级管理，聚焦四类文件操作：**新增 / 更新 / 删除下线 / 查找**，校验贯穿其中。核心是**场景驱动**：新增资料时查[场景索引](scenarios/README.md)，**有场景文档才代建目录、插模板、执行校验；无场景文档只推荐操作，不擅自动手**。 | 17 | +本 skill 以《[msModelSlim 资料规范](../../docs/zh/contributing/development_guide/docs_standards/README.md)》为唯一依据，负责 msModelSlim `docs/` 资料的文件级管理，聚焦四类文件操作：**新增**、**更新**、**删除/下线**、**查找**，校验贯穿其中。核心是**场景驱动**：新增资料时查[场景索引](scenarios/README.md)，**有场景文档才代建目录、插模板、执行校验；无场景文档只推荐操作，不擅自动手**。 |
| 18 | 18 | ||
| 19 | ## 适用场景 | 19 | ## 适用场景 |
| 20 | 20 | ||
| @@ -29,9 +29,9 @@ metadata: | |||
| 29 | 29 | ||
| 30 | ## 核心依据 | 30 | ## 核心依据 |
| 31 | 31 | ||
| 32 | -- **总规范**：[docs_standards/README.md](../../docs/zh/contributing/development_guide/docs_standards/README.md) | 32 | +- **总规范**：《[msModelSlim 资料规范](../../docs/zh/contributing/development_guide/docs_standards/README.md)》 |
| 33 | - **模板与校验清单**：`docs/zh/contributing/development_guide/docs_standards/` 下 `00_common_checklist.md`、`NN_*_template.md` 与 `NN_*_checklist.md` | 33 | - **模板与校验清单**：`docs/zh/contributing/development_guide/docs_standards/` 下 `00_common_checklist.md`、`NN_*_template.md` 与 `NN_*_checklist.md` |
| 34 | -- **新增场景索引**：[scenarios/README.md](scenarios/README.md)（本 skill 内） | 34 | +- **新增场景索引**：《[新增场景索引（机制）](scenarios/README.md)》（本 skill 内） |
| 35 | 35 | ||
| 36 | ## 职责 1 — 新增资料（场景驱动） | 36 | ## 职责 1 — 新增资料（场景驱动） |
| 37 | 37 | ||
| @@ -44,7 +44,7 @@ metadata: | |||
| 44 | 44 | ||
| 45 | ### 1.2 按场景配置执行 | 45 | ### 1.2 按场景配置执行 |
| 46 | 46 | ||
| 47 | -按场景文档 `steps` 操作：按 `create_subdir` 建目录；将 `templates` 中模板复制为目标文件（`docs_standards/` 下 `NN_*_template.md` → 场景文档指定的文件名），**保留 `{{ }}` 占位符与 `[OPTIONAL]` 标记**，供用户填充。目标目录同名判定按三态：目录不存在 → 按新增；目录在但为空 → 复用继续新增；目录在但只缺部分文档 → 补插缺失文件；仅当**同名文档已存在**才转为"更新"职责，不重复创建。 | 47 | +按场景文档 `steps` 操作：按 `create_subdir` 建目录；将 `templates` 中模板复制为目标文件（`docs_standards/` 下 `NN_*_template.md` → 场景文档指定的文件名），**保留 `{{ }}` 占位符与 `[OPTIONAL]` 标记**，供用户填充。目标目录同名判定：①目录不存在 → 按新增；②目录在但为空 → 复用继续新增；③目录在但只缺部分文档 → 补插缺失文件；④**同名文档已存在** → 转为"更新"职责，不重复创建。 |
| 48 | 48 | ||
| 49 | ### 1.3 用户填充 | 49 | ### 1.3 用户填充 |
| 50 | 50 | ||
| @@ -52,11 +52,11 @@ metadata: | |||
| 52 | 52 | ||
| 53 | ### 1.4 校验 | 53 | ### 1.4 校验 |
| 54 | 54 | ||
| 55 | -**分别校验场景特有校验清单与文档类型清单并综合结果**：先按场景文档"场景特有校验清单"（若配置）逐条检查，再按插入模板对应的文档类型清单逐条检查，并叠加[《公共校验清单》](../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md)（CE-01~CE-04、CW-01~CW-02）。全部条目合并为一份报告表（见职责 5），任一 ERROR 未解决即**不通过**。 | 55 | +**分别校验场景特有校验清单与文档类型清单并综合结果**：先按场景文档"场景特有校验清单"（若配置）逐条检查，再按插入模板对应的文档类型清单逐条检查，并叠加《[公共校验清单](../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md)》（CE-01~CE-04、CW-01~CW-02）。全部条目合并为一份报告表（见职责 5），已按豁免机制声明豁免的条目不计入，其余任一 ERROR 未解决即**不通过**。 |
| 56 | 56 | ||
| 57 | ### 1.5 修复至通过 | 57 | ### 1.5 修复至通过 |
| 58 | 58 | ||
| 59 | -遵循修复优先级（CE → 类型前缀序，如词条 CE → G>S>L>C>P>R>K），直至无 ERROR；WARN 项提示用户是否处理。确有合理原因无法满足的条目，按豁免机制在文档顶部声明 `<!-- waiver: 编号 原因：xxx -->`。 | 59 | +遵循修复优先级（CE → 类型前缀序，如词条 CE → TE>TW），直至无 ERROR；WARN 项提示用户是否处理。确有合理原因无法满足的条目，按豁免机制在文档顶部声明 `<!-- waiver: 编号 原因：xxx -->`。 |
| 60 | 60 | ||
| 61 | ## 职责 2 — 更新资料 | 61 | ## 职责 2 — 更新资料 |
| 62 | 62 | ||
| @@ -79,7 +79,7 @@ metadata: | |||
| 79 | 79 | ||
| 80 | ## 职责 5 — 校验（横切） | 80 | ## 职责 5 — 校验（横切） |
| 81 | 81 | ||
| 82 | -对照场景特有校验清单（若配置）+ 文档类型清单 + [《公共校验清单》](../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md)分别逐条检查，合并输出报告表： | 82 | +对照场景特有校验清单（若配置）+ 文档类型清单 + 《[公共校验清单](../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md)》分别逐条检查，合并输出报告表： |
| 83 | 83 | ||
| 84 | ```text | 84 | ```text |
| 85 | | 编号 | 级别 | 文档 | 条目 | 失败原因 | 修复建议 | | 85 | | 编号 | 级别 | 文档 | 条目 | 失败原因 | 修复建议 | |
| @@ -87,7 +87,7 @@ metadata: | |||
| 87 | 87 | ||
| 88 | - **ERROR**：必须修复，任一 ERROR 未解决即校验**不通过**。 | 88 | - **ERROR**：必须修复，任一 ERROR 未解决即校验**不通过**。 |
| 89 | - **WARN**：建议修复，仅 WARN 不满足时结论为**需修订**。 | 89 | - **WARN**：建议修复，仅 WARN 不满足时结论为**需修订**。 |
| 90 | -- **豁免**：文档顶部 `<!-- waiver: 编号 原因：xxx -->`；ERROR 豁免 ≤ 2 项，WARN 不限。 | 90 | +- **豁免**：文档顶部 `<!-- waiver: 编号 原因：xxx -->`；ERROR 豁免 ≤2项（豁免后视为通过），WARN 不限。 |
| 91 | - **触发时机**：新增填充后全量校验；修改 / 删除后增量校验。 | 91 | - **触发时机**：新增填充后全量校验；修改 / 删除后增量校验。 |
| 92 | 92 | ||
| 93 | ## 职责 6 — 整体检查 | 93 | ## 职责 6 — 整体检查 |
| @@ -98,7 +98,7 @@ metadata: | |||
| 98 | 98 | ||
| 99 | ### 6.2 链接完整性 | 99 | ### 6.2 链接完整性 |
| 100 | 100 | ||
| 101 | -按[链接检查](references/link_check.md)扫描 docs 内内部相对链接，报告断链与修复建议。 | 101 | +按[链接检查](references/link_check.md)扫描 docs 内部相对链接，报告断链与修复建议。 |
| 102 | 102 | ||
| 103 | ### 6.3 生命周期 / 质量 | 103 | ### 6.3 生命周期 / 质量 |
| 104 | 104 | ||
| @@ -112,7 +112,7 @@ metadata: | |||
| 112 | 112 | ||
| 113 | - **无场景文档不代建**：新增诉求未命中场景索引时，只推荐操作，不建目录、不插模板。 | 113 | - **无场景文档不代建**：新增诉求未命中场景索引时，只推荐操作，不建目录、不插模板。 |
| 114 | - **不修改用户已填充的内容**：校验阶段只报告与建议，不擅自改动。 | 114 | - **不修改用户已填充的内容**：校验阶段只报告与建议，不擅自改动。 |
| 115 | -- **模板脚手架残留**：模板自带的教学性/脚手架章节（如 01 词条的「排版规范」）属模板指令、非用户填充内容；校验发现残留时**建议删除，由用户确认后执行**，不擅自删。 | 115 | +- **模板脚手架残留**：模板自带的教学性/脚手架章节属模板指令、非用户填充内容；校验发现残留时**建议删除，由用户确认后执行**，不擅自删。 |
| 116 | - **不删除模板的 `{{ }}` 占位符与 `[OPTIONAL]` 标记**，除非用户明确要求。 | 116 | - **不删除模板的 `{{ }}` 占位符与 `[OPTIONAL]` 标记**，除非用户明确要求。 |
| 117 | - **不新增模板规范之外的结构**：模板/校验清单未定义的章节，先更新规范（或场景文档）再使用。 | 117 | - **不新增模板规范之外的结构**：模板/校验清单未定义的章节，先更新规范（或场景文档）再使用。 |
| 118 | - **删除前先确认影响**：删除 / 下线资料先处理反向链接，并在版本说明声明。 | 118 | - **删除前先确认影响**：删除 / 下线资料先处理反向链接，并在版本说明声明。 |
| @@ -11,7 +11,7 @@ | |||
| 11 | 3. 按区域分类统计，每个区域下列出文档文件与子目录。 | 11 | 3. 按区域分类统计，每个区域下列出文档文件与子目录。 |
| 12 | 4. 对每个文档标注： | 12 | 4. 对每个文档标注： |
| 13 | - 所属区域。 | 13 | - 所属区域。 |
| 14 | - - 文档类型：5类模板文档（算法词条 `term_*.md` / 流程指南 / 案例参考 / 量化配置文档 / CLI 文档）、自由文档、README。 | 14 | + - 文档类型：5类模板文档（术语词条 `term_*.md` / 流程指南 / 案例参考 / 量化配置文档 / CLI 文档）、自由文档、README。 |
| 15 | - 是否模板体系内（对应哪个模板 / 校验清单）。 | 15 | - 是否模板体系内（对应哪个模板 / 校验清单）。 |
| 16 | 16 | ||
| 17 | ## 输出格式 | 17 | ## 输出格式 |
| @@ -8,11 +8,11 @@ | |||
| 8 | 8 | ||
| 9 | | 检查项 | 判定 | 处理建议 | | 9 | | 检查项 | 判定 | 处理建议 | |
| 10 | | --- | --- | --- | | 10 | | --- | --- | --- | |
| 11 | -| 占位残留 | 文档中含 `{{ }}`、模板注释、`TODO`、`FIXME`、`待补充`、`TBD`（对齐[《公共校验清单》](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md) CE-01 / CE-02） | 提示补充实际内容 | | 11 | +| 占位残留 | 文档中含 `{{ }}`、模板注释、`TODO`、`FIXME`、`待补充`、`TBD`（对齐《[公共校验清单](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md)》 CE-01 / CE-02） | 提示补充实际内容 | |
| 12 | | 引用已下线特性 | 文档引用已下线模型 / 算法 / 接口 | 与版本说明核对，更新或废弃（对齐职责 3 下线流程） | | 12 | | 引用已下线特性 | 文档引用已下线模型 / 算法 / 接口 | 与版本说明核对，更新或废弃（对齐职责 3 下线流程） | |
| 13 | | 版本时效 | `release_notes` 是否覆盖当前版本变更 | 提示补充 | | 13 | | 版本时效 | `release_notes` 是否覆盖当前版本变更 | 提示补充 | |
| 14 | | 文档陈旧 | 文档描述的版本 / 能力与当前实现不一致 | 提示更新 | | 14 | | 文档陈旧 | 文档描述的版本 / 能力与当前实现不一致 | 提示更新 | |
| 15 | -| 敏感信息 | 含密钥、令牌、内网地址、个人路径（对齐[《公共校验清单》](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md) CE-03） | 立即提示移除 | | 15 | +| 敏感信息 | 含密钥、令牌、内网地址、个人路径（对齐《[公共校验清单](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md)》 CE-03） | 立即提示移除 | |
| 16 | 16 | ||
| 17 | ## 输出 | 17 | ## 输出 |
| 18 | 18 | ||
| @@ -20,6 +20,8 @@ | |||
| 20 | 20 | ||
| 21 | ```text | 21 | ```text |
| 22 | | 文档 | 检查项 | 发现 | 建议 | | 22 | | 文档 | 检查项 | 发现 | 建议 | |
| 23 | +| --- | --- | --- | --- | | ||
| 24 | +| `01_term_glossary_template.md` | 占位残留 | `## 概述` 含未填充的 `{{ content }}` | 补充实际内容 | | ||
| 23 | ``` | 25 | ``` |
| 24 | 26 | ||
| 25 | ## 注意 | 27 | ## 注意 |
| @@ -7,7 +7,7 @@ | |||
| 7 | ## 检查范围 | 7 | ## 检查范围 |
| 8 | 8 | ||
| 9 | - 链接形如 `[text](../xx/yy.md)`、`[text](./zz.md)` 的相对路径链接。 | 9 | - 链接形如 `[text](../xx/yy.md)`、`[text](./zz.md)` 的相对路径链接。 |
| 10 | -- 排除：外网 URL（http/https）、锚点链接（`#xxx`）、`{{ }}` 模板占位链接、词条文件顶部 TODO 已登记的待建词条目标（`term_*.md`，视为已规划，对齐词条校验 K02 / L04）。 | 10 | +- 排除：外网 URL（http/https）、锚点链接（`#xxx`）、`{{ }}` 模板占位链接、词条文件顶部 TODO 已登记的待建词条目标（`term_*.md`，视为已规划，对齐《[术语词条校验清单](../../../docs/zh/contributing/development_guide/docs_standards/01_term_glossary_checklist.md)》 TE-33 / TW-05）。 |
| 11 | 11 | ||
| 12 | ## 步骤 | 12 | ## 步骤 |
| 13 | 13 | ||
| @@ -25,6 +25,6 @@ | |||
| 25 | ## 修复建议 | 25 | ## 修复建议 |
| 26 | 26 | ||
| 27 | - 断链常见原因：目标文档移动 / 删除、文件名大小写不一致、`NN_` 前缀变更。 | 27 | - 断链常见原因：目标文档移动 / 删除、文件名大小写不一致、`NN_` 前缀变更。 |
| 28 | -- 本检查对应[《公共校验清单》](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md) CW-02（渲染与链接）；删除 / 下线文档后须重跑本检查做断链复查（见 SKILL.md 职责 3）。 | 28 | +- 本检查对应《[公共校验清单](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md)》 CW-02（渲染与链接）；删除 / 下线文档后须重跑本检查做断链复查（见 [SKILL.md 职责 3](../SKILL.md#职责-3--删除--下线资料完整流程)）。 |
| 29 | - 修复后重新检查确认。 | 29 | - 修复后重新检查确认。 |
| 30 | - 仅报告与建议，不自动改动文档。 | 30 | - 仅报告与建议，不自动改动文档。 |
| @@ -1,30 +1,30 @@ | |||
| 1 | # 校验规则 | 1 | # 校验规则 |
| 2 | 2 | ||
| 3 | -按文档类型对照 `docs/zh/contributing/development_guide/docs_standards/` 下对应校验清单执行校验。**新增场景校验 = 场景特有校验清单（若配置）+ 文档类型清单 + [《公共校验清单》](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md)，分别执行并综合结果**（见 `scenarios/` 场景文档）。场景特有校验清单仅含该场景特有、文档类型清单未覆盖的条目，不重复类型清单。 | 3 | +按文档类型对照 `docs/zh/contributing/development_guide/docs_standards/` 下对应校验清单执行校验。**新增场景校验 = 场景特有校验清单（若配置）+ 文档类型清单 + 《[公共校验清单](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md)》，分别执行并综合结果**（见 [scenarios/ 场景文档](../scenarios/README.md)，场景特有校验清单构成见下文「校验清单构成」节）。 |
| 4 | 4 | ||
| 5 | ## 校验清单构成 | 5 | ## 校验清单构成 |
| 6 | 6 | ||
| 7 | -- **[《公共校验清单》](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md)**：适用于所有文档，含通用 ERROR（CE-01~CE-04：占位符 / 模板注释 / 敏感信息 / 标题）与 WARN（CW-01~CW-02：可选章节 / 渲染与链接）。 | 7 | +- **《[公共校验清单](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md)》**：适用于所有文档，含通用 ERROR（CE-01~CE-04：占位符 / 模板注释 / 敏感信息 / 标题）与 WARN（CW-01~CW-02：可选章节 / 渲染与链接）。 |
| 8 | -- **类型校验清单**：`NN_*_checklist.md`，类型专属条目。 | 8 | +- **文档类型清单**：`NN_*_checklist.md`，类型专属条目。 |
| 9 | - **场景特有校验清单**：可选。场景文档正文"场景特有校验清单"小节，仅含该场景特有、文档类型清单未覆盖的条目（如场景独有章节、专属字段、特殊命名），不重复类型清单；校验时与文档类型清单**分别执行并综合结果**。 | 9 | - **场景特有校验清单**：可选。场景文档正文"场景特有校验清单"小节，仅含该场景特有、文档类型清单未覆盖的条目（如场景独有章节、专属字段、特殊命名），不重复类型清单；校验时与文档类型清单**分别执行并综合结果**。 |
| 10 | 10 | ||
| 11 | ## 文档类型 → 校验清单 | 11 | ## 文档类型 → 校验清单 |
| 12 | 12 | ||
| 13 | -| 文档类型 | 类型校验清单 | | 13 | +| 文档类型 | 文档类型清单 | |
| 14 | | --- | --- | | 14 | | --- | --- | |
| 15 | -| 算法词条 / 术语词条 | [《量化术语百科校验清单》](../../../docs/zh/contributing/development_guide/docs_standards/01_quantization_glossary_checklist.md) | | 15 | +| 术语词条 | 《[术语词条校验清单](../../../docs/zh/contributing/development_guide/docs_standards/01_term_glossary_checklist.md)》 | |
| 16 | -| 流程指南 / 使用指南 | [《流程指南校验清单》](../../../docs/zh/contributing/development_guide/docs_standards/02_process_guide_checklist.md) | | 16 | +| 流程指南 / 使用指南 | 《[流程指南校验清单](../../../docs/zh/contributing/development_guide/docs_standards/02_process_guide_checklist.md)》 | |
| 17 | -| 案例参考 | [《通用案例校验清单》](../../../docs/zh/contributing/development_guide/docs_standards/03_general_case_checklist.md) | | 17 | +| 案例参考 | 《[通用案例校验清单](../../../docs/zh/contributing/development_guide/docs_standards/03_general_case_checklist.md)》 | |
| 18 | -| 量化配置文档 | [《量化配置文档校验清单》](../../../docs/zh/contributing/development_guide/docs_standards/04_quantization_config_document_checklist.md) | | 18 | +| 量化配置文档 | 《[量化配置文档校验清单](../../../docs/zh/contributing/development_guide/docs_standards/04_quantization_config_document_checklist.md)》 | |
| 19 | -| CLI 文档 | [《命令行 API 文档校验清单》](../../../docs/zh/contributing/development_guide/docs_standards/05_cli_api_contract_checklist.md) | | 19 | +| CLI 文档 | 《[命令行 API 文档校验清单](../../../docs/zh/contributing/development_guide/docs_standards/05_cli_api_contract_checklist.md)》 | |
| 20 | -| 模板体系外（安装指南 / 快速入门 / FAQ 等） | 无类型清单，以[《公共校验清单》](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md)的 ERROR 条目（CE-01~CE-04）为兜底 | | 20 | +| 模板体系外（安装指南 / 快速入门 / FAQ 等） | 无文档类型清单，以《[公共校验清单](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md)》的 ERROR 条目（CE-01~CE-04）为兜底 | |
| 21 | 21 | ||
| 22 | -模板体系外文档校验口径见规范[《msModelSlim 资料规范》](../../../docs/zh/contributing/development_guide/docs_standards/README.md)第 2.2 节：至少满足[《公共校验清单》](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md)的 ERROR 条目。 | 22 | +模板体系外文档校验口径见规范《[msModelSlim 资料规范](../../../docs/zh/contributing/development_guide/docs_standards/README.md)》第 2.2 节：至少满足《[公共校验清单](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md)》的 ERROR 条目。 |
| 23 | 23 | ||
| 24 | ## 公共清单执行口径 | 24 | ## 公共清单执行口径 |
| 25 | 25 | ||
| 26 | -- **CE-02（模板注释）**：覆盖模板自带的教学性 / 脚手架章节（如 01 词条的「排版规范」），不仅限 `> **注释：**` 块引用。发布文档中此类"指导作者写作"的模板指令章节应删除；确属发布内容需保留的，须改写为正式说明并去除占位示例。判定依据见[《公共校验清单》](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md) CE-02。 | 26 | +- **CE-02（模板注释）**：覆盖模板自带的教学性 / 脚手架章节，不仅限 `> **注释：**` 块引用。发布文档中此类"指导作者写作"的模板指令章节应删除；确属发布内容需保留的，须改写为正式说明并去除占位示例。判定依据见《[公共校验清单](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md)》 CE-02。 |
| 27 | -- **CW-01（可选章节）**：删除不适用 `[OPTIONAL]` 章节时，其后章节按顺序重新编号、不留空号；保留的章节剥除 `[OPTIONAL]` 前缀。判定依据见[《公共校验清单》](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md) CW-01。 | 27 | +- **CW-01（可选章节）**：删除不适用 `[OPTIONAL]` 章节时，其后章节按顺序重新编号、不留空号；保留的章节剥除 `[OPTIONAL]` 前缀。判定依据见《[公共校验清单](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md)》 CW-01。 |
| 28 | 28 | ||
| 29 | ## 校验报告格式 | 29 | ## 校验报告格式 |
| 30 | 30 | ||
| @@ -32,6 +32,7 @@ | |||
| 32 | 32 | ||
| 33 | ```text | 33 | ```text |
| 34 | | 编号 | 级别 | 文档 | 条目 | 失败原因 | 修复建议 | | 34 | | 编号 | 级别 | 文档 | 条目 | 失败原因 | 修复建议 | |
| 35 | +| CE-01 | ERROR | term_xxx.md | 模板占位符 | 残留 {{ term_name }} | 替换为实际内容 | | ||
| 35 | ``` | 36 | ``` |
| 36 | 37 | ||
| 37 | - **ERROR**：必须修复，任一 ERROR 未解决即校验**不通过**。 | 38 | - **ERROR**：必须修复，任一 ERROR 未解决即校验**不通过**。 |
| @@ -40,25 +41,25 @@ | |||
| 40 | 41 | ||
| 41 | ## 修复优先级 | 42 | ## 修复优先级 |
| 42 | 43 | ||
| 43 | -先公共后类型：CE 条目优先；再按类型清单编号顺序修复（词条：G > S > L > C > P > R > K；流程 PG 序；案例 GC 序；配置 Q 序；CLI C 序）。通用与结构问题优先，避免后续条目连锁失败。 | 44 | +先公共后类型：CE 条目优先；再按文档类型清单编号顺序修复（词条 TE- / TW- 序；流程 PE- / PW- 序；案例 GC 序；配置 QE- / QW- 序；CLI LE- / LW- 序）。ERROR 条目优先于 WARN 条目，避免后续条目连锁失败。 |
| 44 | 45 | ||
| 45 | ## 豁免机制 | 46 | ## 豁免机制 |
| 46 | 47 | ||
| 47 | 某条目确有合理原因无法满足时，在文档顶部以 HTML 注释声明： | 48 | 某条目确有合理原因无法满足时，在文档顶部以 HTML 注释声明： |
| 48 | 49 | ||
| 49 | ```text | 50 | ```text |
| 50 | -<!-- waiver: P02 原因：纯概念术语无公式 --> | 51 | +<!-- waiver: TE-28 原因：纯概念术语无公式 --> |
| 51 | ``` | 52 | ``` |
| 52 | 53 | ||
| 53 | -校验时跳过对应条目并记录豁免原因。豁免不得用于规避 ERROR 类条目超过 2 项，WARN 条目不设豁免数量限制。 | 54 | +校验时跳过对应条目并记录豁免原因。豁免不得用于规避 ERROR 类条目超过2项，WARN 条目不设豁免数量限制。 |
| 54 | 55 | ||
| 55 | -## 词条待建 TODO 登记（统一动作，K02 / L04） | 56 | +## 词条待建 TODO 登记（统一动作，TE-33 / TW-05） |
| 56 | 57 | ||
| 57 | **所有词条的统一动作**：新增词条时，凡 `## 关联词条` 链接到尚未创建的 `term_*.md`，一律在**词条文件顶部以 TODO 列表登记**（如 `<!-- TODO: term_xxx.md 待建 -->`）。该要求适用于一切词条类文档，是 skill 通用规则，不写入具体场景文档。 | 58 | **所有词条的统一动作**：新增词条时，凡 `## 关联词条` 链接到尚未创建的 `term_*.md`，一律在**词条文件顶部以 TODO 列表登记**（如 `<!-- TODO: term_xxx.md 待建 -->`）。该要求适用于一切词条类文档，是 skill 通用规则，不写入具体场景文档。 |
| 58 | 59 | ||
| 59 | -校验时：已登记待建词条豁免 K02（ERROR）与 L04（WARN）的存在性检查；未登记则报告 ERROR，提示登记或修正链接。不设中心化待建清单。 | 60 | +校验时：已登记待建词条豁免 TE-33（ERROR）与 TW-05（WARN）的存在性检查；未登记则报告 ERROR，提示登记或修正链接。不设中心化待建清单。 |
| 60 | 61 | ||
| 61 | -**与 L09 的分工**：L09（链接路径可解析，ERROR）只校验相对路径能否在仓库内解析——待建词条链接路径合法即满足，与待建登记无关。目标文件**存在性**由 K02 / L04 管：已登记 TODO 的待建词条链接，其目标文件不存在属"已规划"，K02 通过、L04 豁免，仅记录待建，**不**报 L09 存在性类 ERROR。 | 62 | +**与 TE-17 的分工**：TE-17（链接路径可解析，ERROR）只校验相对路径能否在仓库内解析——待建词条链接路径合法即满足，与待建登记无关。目标文件**存在性**由 TE-33 / TW-05 管：已登记 TODO 的待建词条链接，其目标文件不存在属"已规划"，TE-33 通过、TW-05 豁免，仅记录待建，**不**报 TE-17 存在性类 ERROR。 |
| 62 | 63 | ||
| 63 | ## 链接校验基准 | 64 | ## 链接校验基准 |
| 64 | 65 | ||
| @@ -68,4 +69,4 @@ | |||
| 68 | 69 | ||
| 69 | - 新增资料填充完成后立即全量校验。 | 70 | - 新增资料填充完成后立即全量校验。 |
| 70 | - 修改既有文档后做增量校验（仅校验变更文件及受其引用影响的文件）。 | 71 | - 修改既有文档后做增量校验（仅校验变更文件及受其引用影响的文件）。 |
| 71 | -- 删除 / 下线文档后做断链复查（见职责 3）。 | 72 | +- 删除 / 下线文档后做断链复查（见 [SKILL.md 职责 3](../SKILL.md#职责-3--删除--下线资料完整流程)）。 |
| @@ -7,34 +7,36 @@ | |||
| 7 | skill 新增资料时读取本索引： | 7 | skill 新增资料时读取本索引： |
| 8 | 8 | ||
| 9 | - **命中**某场景文档 → 按该文档的 `target_dir` / `templates` 与正文`操作步骤`执行（建目录、插模板）；校验时**分别执行场景特有校验清单与文档类型清单并综合结果**。 | 9 | - **命中**某场景文档 → 按该文档的 `target_dir` / `templates` 与正文`操作步骤`执行（建目录、插模板）；校验时**分别执行场景特有校验清单与文档类型清单并综合结果**。 |
| 10 | -- **未命中** → 只推荐用户操作（应有的目标目录、模板与校验依据），不建目录、不插模板（见 SKILL.md 红线）。 | 10 | +- **未命中** → 只推荐用户操作（应有的目标目录、模板与校验依据），不建目录、不插模板（见 [SKILL.md 红线](../SKILL.md#红线)）。 |
| 11 | 11 | ||
| 12 | ## 场景文档 schema | 12 | ## 场景文档 schema |
| 13 | 13 | ||
| 14 | 每个场景文档以 YAML frontmatter 声明配置，正文以步骤说明具体操作： | 14 | 每个场景文档以 YAML frontmatter 声明配置，正文以步骤说明具体操作： |
| 15 | 15 | ||
| 16 | -| 字段 | 含义 | | 16 | +| 字段 | 类型 | 必填 | 默认值 | 含义 | |
| 17 | -| --- | --- | | 17 | +| --- | --- | --- | --- | --- | |
| 18 | -| `name` | 场景唯一标识（kebab-case），须与文件名一致。 | | 18 | +| `name` | string | 是 | — | 场景唯一标识（kebab-case），须与文件名一致。 | |
| 19 | -| `title` | 场景名。 | | 19 | +| `title` | string | 是 | — | 场景名。 | |
| 20 | -| `triggers` | 用户诉求触发关键词，供 skill 匹配场景。 | | 20 | +| `triggers` | string[] | 是 | — | 用户诉求触发关键词，供 skill 匹配场景。 | |
| 21 | -| `target_dir` | 目标目录（仓库相对路径）；`<占位>` 按命名规则替换。 | | 21 | +| `target_dir` | string | 是 | — | 目标目录（仓库相对路径）；`<占位>` 按命名规则替换。 | |
| 22 | -| `create_subdir` | 是否新建子目录。 | | 22 | +| `create_subdir` | boolean | 否 | 未声明时不建子目录 | 是否新建子目录。 | |
| 23 | -| `templates` | 要插入的模板（`docs_standards/` 下 `NN_*_template.md`）→ 目标文件名模式。 | | 23 | +| `subdir_name` | string | 否（`create_subdir: true` 时必填） | — | 新建子目录名（英文小写，多词以下划线连接，与目标目录既有文档命名一致）。 | |
| 24 | -| `naming_rules` | 目录 / 文件命名规则。 | | 24 | +| `templates` | object | 是 | — | 要插入的模板（`docs_standards/` 下 `NN_*_template.md`）→ 目标文件名模式。 | |
| 25 | +| `naming_rules` | string | 是 | — | 目录 / 文件命名规则。 | | ||
| 25 | 26 | ||
| 26 | -正文至少包含 `## 目标形态`、`## 命名规则`、`## 操作步骤`、`## 校验依据`。**场景特有校验清单**（可选）写入正文 `## 场景特有校验清单` 小节，**仅列该场景特有、文档类型清单未覆盖的条目**（不重复类型清单）；校验时与插入模板对应的文档类型清单分别执行并综合结果。 | 27 | +正文至少包含 `## 目标形态`（新增后的文档结构与位置）、`## 命名规则`（目录 / 文件命名规则）、`## 操作步骤`（具体动作与顺序）、`## 校验依据`（本场景校验清单口径）。**场景特有校验清单**（可选）写入正文 `## 场景特有校验清单` 小节，**仅列该场景特有、文档类型清单未覆盖的条目**（不重复类型清单）；校验时与插入模板对应的文档类型清单分别执行并综合结果。 |
| 27 | 28 | ||
| 28 | -样例：见 [example.md](example.md)（示例场景文档，非已登记真实场景，供新增场景时复制改写）。 | 29 | +样例：见 《[新增示例场景](example.md)》（示例场景文档，非已登记真实场景，供新增场景时复制改写）。 |
| 29 | 30 | ||
| 30 | ## 如何新增场景 | 31 | ## 如何新增场景 |
| 31 | 32 | ||
| 32 | -1. 场景目标目录、模板、校验口径须可在资料规范（`docs/zh/contributing/development_guide/docs_standards/README.md`）中追溯；规范未定义的结构先更新规范再登记场景。 | 33 | +**前提**：场景目标目录、模板、校验口径须可在资料规范（`docs/zh/contributing/development_guide/docs_standards/README.md`）中追溯；规范未定义的结构先更新规范再登记场景。 |
| 33 | -2. 复用 `docs_standards/` 下既有模板；如需场景特有校验清单，写入正文"场景特有校验清单"小节，仅列该场景特有条目，不重复文档类型清单。 | 34 | + |
| 34 | -3. 新建 `<name>.md`，按上表 schema 填写，并在本 README 登记（可另建"场景清单"小节维护索引）。 | 35 | +1. 复用 `docs_standards/` 下既有模板；如需场景特有校验清单，写入正文"场景特有校验清单"小节，仅列该场景特有条目，不重复文档类型清单。预期产物：正文章节骨架。 |
| 35 | -4. 规范变更时同步更新对应场景文档。 | 36 | +2. 新建 `<name>.md`，按上表 schema 填写，并在本 README 登记（可另建"场景清单"小节维护索引）。预期产物：一份可被 skill 识别的场景文档 + 索引登记。 |
| 37 | +3. 规范变更时同步更新对应场景文档。预期产物：场景文档与规范保持一致。 | ||
| 36 | 38 | ||
| 37 | ## 与 skill 的配合 | 39 | ## 与 skill 的配合 |
| 38 | 40 | ||
| 39 | -- skill 职责 1.1 读取本索引定位场景：命中 → 读场景文档配置并执行；**未命中 → 只推荐用户操作，不建目录、不插模板**（见 SKILL.md 红线）。 | 41 | +- skill 职责 1.1 读取本索引定位场景：命中 → 读场景文档配置并执行；**未命中 → 只推荐用户操作，不建目录、不插模板**（见 [SKILL.md 红线](../SKILL.md#红线)）。 |
| 40 | - 场景文档只描述"目标形态 + 操作步骤"，不包含既有文档内容，避免与资料校验冲突。 | 42 | - 场景文档只描述"目标形态 + 操作步骤"，不包含既有文档内容，避免与资料校验冲突。 |
| @@ -11,25 +11,25 @@ templates: | |||
| 11 | 11 | ||
| 12 | # 新增示例场景 | 12 | # 新增示例场景 |
| 13 | 13 | ||
| 14 | -> **样例说明**：本文件是场景文档的**样例**，仅演示结构、字段与正文写法，**不作为已登记的真实场景**。新增真实场景时复制本文件为 `<name>.md`，改写 `target_dir` / `templates` 与正文（含可选的"场景特有校验清单"）即可。frontmatter 字段含义见 [README](README.md)。 | 14 | +> **样例说明**：本文件是场景文档的**样例**，仅演示结构、字段与正文写法，**不作为已登记的真实场景**。新增真实场景时复制本文件为 `<name>.md`，改写 `target_dir` / `templates` 与正文（含可选的"场景特有校验清单"）即可。frontmatter 字段含义见 《[新增场景索引（机制）](README.md)》。 |
| 15 | 15 | ||
| 16 | ## 目标形态 | 16 | ## 目标形态 |
| 17 | 17 | ||
| 18 | 描述该场景新增资料后的目标形态：在哪个目录、产出哪几篇文档、各属什么文档类型。示例： | 18 | 描述该场景新增资料后的目标形态：在哪个目录、产出哪几篇文档、各属什么文档类型。示例： |
| 19 | 19 | ||
| 20 | -- 在 `docs/zh/<领域>/` 下新增一篇使用指南 `<name>.md`，套 [02 流程模板](../../../docs/zh/contributing/development_guide/docs_standards/02_process_guide_template.md)。 | 20 | +- 在 `docs/zh/<领域>/` 下新增一篇使用指南 `<name>.md`，套 《[流程指南模板](../../../docs/zh/contributing/development_guide/docs_standards/02_process_guide_template.md)》。 |
| 21 | 21 | ||
| 22 | ## 命名规则 | 22 | ## 命名规则 |
| 23 | 23 | ||
| 24 | -说明目录 / 文件命名规则（英文小写、连接符风格、与既有文档一致等）。 | 24 | +说明目录 / 文件命名规则（英文小写、连接符风格、与既有文档一致等）。替换示例：`<name>` → `flex_smooth_quant`。 |
| 25 | 25 | ||
| 26 | ## 操作步骤 | 26 | ## 操作步骤 |
| 27 | 27 | ||
| 28 | -1. 确认 `<name>` 命名，检查目标目录下无同名文档；同名则转为"更新"职责。 | 28 | +1. 确认 `<name>` 命名，检查目标目录下无同名文档；同名则转为"更新"职责。预期产物：命名与同名判定结论。 |
| 29 | -2. 按 `create_subdir` 建子目录（`create_subdir: true` 时）。 | 29 | +2. 按 `create_subdir` 建子目录（`create_subdir: true` 时）。预期产物：`target_dir` 下子目录已创建。 |
| 30 | -3. 复制 `templates` 中各模板为目标文件，**保留 `{{ }}` 占位符与 `[OPTIONAL]` 标记**，供用户填充。 | 30 | +3. 复制 `templates` 中各模板为目标文件，**保留 `{{ }}` 占位符与 `[OPTIONAL]` 标记**，供用户填充。预期产物：目标文件已生成且含占位符。 |
| 31 | -4. 用户填充后**分别校验**本场景特有校验清单与文档类型清单（本例[《流程指南校验清单》](../../../docs/zh/contributing/development_guide/docs_standards/02_process_guide_checklist.md)），并叠加[《公共校验清单》](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md)，综合结果。 | 31 | +4. 用户填充后**分别校验**本场景特有校验清单与文档类型清单（本例《[流程指南校验清单](../../../docs/zh/contributing/development_guide/docs_standards/02_process_guide_checklist.md)》），并叠加《[公共校验清单](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md)》，综合结果。预期产物：校验报告表。 |
| 32 | -5. 修复至无 ERROR；WARN 项提示用户决定是否处理。 | 32 | +5. 修复至无 ERROR；WARN 项提示用户决定是否处理。预期产物：无 ERROR，WARN 已向用户提示。 |
| 33 | 33 | ||
| 34 | ## 场景特有校验清单 | 34 | ## 场景特有校验清单 |
| 35 | 35 | ||
| @@ -43,8 +43,8 @@ templates: | |||
| 43 | ## 校验依据 | 43 | ## 校验依据 |
| 44 | 44 | ||
| 45 | - **场景特有校验清单**：正文"场景特有校验清单"小节（若有），仅本场景特有条目。 | 45 | - **场景特有校验清单**：正文"场景特有校验清单"小节（若有），仅本场景特有条目。 |
| 46 | -- **文档类型清单**：按插入模板对应的类型清单（本例[《流程指南校验清单》](../../../docs/zh/contributing/development_guide/docs_standards/02_process_guide_checklist.md)）；类型清单已覆盖的条目不写入场景特有清单。 | 46 | +- **文档类型清单**：按插入模板对应的类型清单（本例《[流程指南校验清单](../../../docs/zh/contributing/development_guide/docs_standards/02_process_guide_checklist.md)》）；类型清单已覆盖的条目不写入场景特有清单。 |
| 47 | -- **公共兜底**：[《公共校验清单》](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md) 的 CE-01~CE-04、CW-01~CW-02。 | 47 | +- **公共兜底**：《[公共校验清单](../../../docs/zh/contributing/development_guide/docs_standards/00_common_checklist.md)》 的 CE-01~CE-04、CW-01~CW-02。 |
| 48 | - 三类清单**分别逐条执行并综合结果**；修复优先级：CE → 类型前缀序 → 场景特有序号。 | 48 | - 三类清单**分别逐条执行并综合结果**；修复优先级：CE → 类型前缀序 → 场景特有序号。 |
| 49 | 49 | ||
| 50 | ## 编写注意事项 | 50 | ## 编写注意事项 |
| @@ -54,4 +54,4 @@ templates: | |||
| 54 | - **操作步骤须含"同名判定"**：明确目标目录 / 文件已存在时的处理——目录不存在 → 按新增；目录在但空 → 复用继续新增；目录在但只缺部分文档 → 补插缺失文件；同名文档已存在 → 转"更新"职责。 | 54 | - **操作步骤须含"同名判定"**：明确目标目录 / 文件已存在时的处理——目录不存在 → 按新增；目录在但空 → 复用继续新增；目录在但只缺部分文档 → 补插缺失文件；同名文档已存在 → 转"更新"职责。 |
| 55 | - **命名规则给显式替换示例**：除规则描述外，补一行 `<占位>` → 实际名称的替换实例（如 `flex_smooth_quant`），减少执行者猜测。 | 55 | - **命名规则给显式替换示例**：除规则描述外，补一行 `<占位>` → 实际名称的替换实例（如 `flex_smooth_quant`），减少执行者猜测。 |
| 56 | - **场景特有校验清单仅列本场景特有项**：不重复文档类型清单条目；校验按"场景 + 类型 + 公共"分别执行并综合结果。 | 56 | - **场景特有校验清单仅列本场景特有项**：不重复文档类型清单条目；校验按"场景 + 类型 + 公共"分别执行并综合结果。 |
| 57 | -- **通用规则不外提**：待建词条 TODO 登记、链接校验基准、公共清单执行口径（CE-02 / CW-01）等属 skill 通用规则（见 `references/validation_rules.md`），不写入场景文档；模板脚手架章节（如 01 词条的「排版规范」）由公共校验 CE-02 兜底，场景文档无需重复。 | 57 | +- **通用规则不外提**：待建词条 TODO 登记、链接校验基准、公共清单执行口径（CE-02 / CW-01）等属 skill 通用规则（见 [references/validation_rules.md](../references/validation_rules.md)），不写入场景文档；模板脚手架章节由公共校验 CE-02 兜底，场景文档无需重复。 |