量化配置文档 Checklist¶
本文用于校验基于《量化配置文档模板》新建或整改的文档，适用于 ModelslimV1ServiceConfig、MultimodalSDServiceConfig、MultimodalVLMServiceConfig 及其引用配置。提交文档前，应逐项确认。
| 编号 | 严重级别 | 校验条目 | 校验方法 | 失败处理建议 |
|---|---|---|---|---|
| Q01 | ERROR | 文件中不允许残留模板占位符 {{ ... }}。 |
全文检索 {{ 与 }} |
将占位符替换为实际内容 |
| Q02 | ERROR | 文件中不允许残留模板注释（以 > **注释：** 开头的块引用中包含“将 xxx 替换为”“必填”“选填”等指导性文字）。 |
检索 > **注释：** 之后的指导性关键词 |
删除模板注释，或替换为正式说明 |
| Q03 | WARN | [OPTIONAL] 前缀仅用于模板定义的可选章节；发布文档时已删除不适用的可选章节及前缀。 |
比对模板章节列表，检查保留章节的标题 | 删除不适用的 [OPTIONAL] 章节，保留的章节去掉前缀 |
| Q04 | ERROR | “配置概述”元信息表格包含配置类和源码链接，两者均可在目标版本源码中定位。 | 检查表格字段完整性，点开源码链接验证 | 补齐缺失字段，修正失效链接 |
| Q05 | WARN | “配置概述”明确说明控制的量化阶段、适用模型或场景，以及在完整配置中的位置。 | 检查概述是否为有效描述文本 | 补充或修正配置概述 |
| Q06 | ERROR | “参数列表”覆盖配置类直接定义及通过继承对外开放的全部字段；字段使用从配置根节点开始的完整路径。 | 逐字段比对 Pydantic 模型/dataclass 定义 | 补齐缺失字段，删除不存在字段，修正路径 |
| Q07 | ERROR | 每个字段的类型、必选/可选状态、默认值与模型定义及运行时校验一致；枚举值、边界、格式约束描述完整。 | 比对模型定义与参数表 | 修正不一致的字段属性 |
| Q08 | WARN | “配置约束”仅描述可由解析器、校验器或加载逻辑判断的规则（互斥、依赖、优先级、回退等）；没有额外约束时已明确填写“无”。 | 检查约束是否可被代码静态校验 | 移除无法校验的实践性约束（移至“注意事项”），或填写“无” |
| Q09 | ERROR | “引用的配置”覆盖本配置使用的全部嵌套配置，链接指向字段说明或独立配置文档；存在联合类型子配置时，已填写“适用字段”“子配置类别”“type 或辨识值”列；普通引用这三列填写“-”。子配置类型较多（超过 5 个）时，允许使用汇总行 + 子配置索引表的模式，汇总行的“type 或辨识值”填写“见下方索引”并链接到索引表。 |
核对配置类中的嵌套类型引用，逐链点检 | 补齐遗漏引用，修正链接目标，补充子配置列；子类型过多时改用索引表模式 |
| Q10 | WARN | “被引用的配置”覆盖所有已知上层入口，注明引用位置和适用场景；没有引用方时已用“无。”替代表格。 | 搜索代码中对本配置的引用 | 补充引用方信息，或填写“无。” |
| Q11 | ERROR | “完整配置参考”提供语法正确的 YAML，配置放在实际的完整字段路径中，可被配置加载入口成功解析。 | YAML 语法检查 + 实际加载验证 | 修正 YAML 语法或路径层级 |
| Q12 | WARN | “完整配置参考”示例值满足参数约束，与参数列表一致；复杂嵌套配置通过 type 标明类型，未使用省略号代替。 |
逐字段比对参数列表中的约束 | 修正不一致的示例值，展开省略部分 |
| Q13 | WARN | “兼容性与迁移”仅在存在版本差异时保留；废弃字段已说明替代方案和迁移方式。 | 与上一稳定版本 diff 比对 | 删除不适用章节，或补充迁移说明 |
| Q14 | WARN | “注意事项”仅描述运行时实践问题（性能、精度、显存等），不重复“配置约束”中已有的校验规则。 | 逐条检查是否可被代码静态校验 | 将可校验规则移至“配置约束”，保留实践问题 |
| Q15 | ERROR | 文档不包含密钥、令牌、内部地址、个人路径或其他敏感信息。 | 全文检索敏感关键词模式 | 移除敏感信息，替换为占位说明 |
| Q16 | WARN | Markdown 表格、标题层级、YAML 代码块和换行渲染正确；内联文档链接有效。 | 渲染预览 + 逐链点检 | 修正格式错误或失效链接 |