# 文档修改检查清单 适用于每次文档改动。逐项记录通过、不通过或不适用及原因,不把勾选清单当作验证结果。 ## 读者与结构 - [ ] DOC-001:本页读者与阅读目标可明确表达。 - [ ] DOC-002:主要职责明确,不混入研发记录。 - [ ] DOC-003~008:概念前提、分页、目录、主定义与稳定引用合适。 - [ ] DOC-018:未参与聊天的人能理解陈述。 ## 用法与示例 - [ ] DOC-004、009:外部归属、片段位置、依赖和假设明确。 - [ ] DOC-010、011:例子有可核对结果,变化范围合理。 - [ ] DOC-012、013:边界、类型、依赖和阶段说明与语法一致。 - [ ] DOC-014:若存在对比,其共同维度与适用条件明确。 - [ ] DOC-015、016:提案未被擅自确认,实现机制未成为语法规则。 - [ ] DOC-017、019:术语、展示记法和格式一致。 ## 证据与协作 - [ ] DOC-020:来源可核查,分析与事实分开,不可读来源未被伪造。 - [ ] DOC-021:文法、导航、示例和状态已同步。 - [ ] DOC-022、023:工作区被保留,文件无本机依赖或凭据,AI 未越过语义决定范围。 - [ ] DOC-024:完成冷读、主题定位与结果预测自查,记录障碍。 ## 自动检查 - [ ] `python3 tools/check_docs.py`:记录退出码与报告。 - [ ] `python3 -m unittest discover -s tools/tests -v`:记录工具测试结果。 - [ ] `git diff --check`:无差异格式问题。 - [ ] 需要提交时另运行 `git diff --cached --check`。 ## 验证等级 | 等级 | 可以报告的事实 | 不能据此宣称 | | --- | --- | --- | | 自动结构检查 | 链接、锚点、围栏和有限约定通过 | 源码已经编译运行 | | 作者语义自查 | 示例计算、上下文与已写规则一致 | 静态类型体系全部实现 | | 作者冷读自查 | 以读者任务检查并记录障碍 | 真实用户可用性实验通过 | | 真实执行或读者测试 | 指定环境和参与者下取得的实际结果 | 所有环境与所有读者均无问题 | 本仓库未提供完整语言编译与执行工具。若未执行,写明“未做编译或运行验证”;不要将预期输出贴成执行日志。 [规则索引](README.md#规则索引) · [工作流](workflow.md)