知识文档写完初稿后，评审常卡在“感觉还差点什么”这种模糊判断上。这份章节要素清单把检查落到可勾选的项目：先看整篇文档的定位、读者与维护信息，再逐章核对目的、前提、步骤、示例、异常与来源，每项配通过标准、证据和负责人，并标出未修复就不能发布的阻断项。适用于操作指南、规范说明、参考手册等知识文档，在初稿完成、评审会前、发布前和定期复审时使用。ONES 文档可承载评审记录与版本留痕，下文按检查流程展开。
要点总览（TL;DR）
- 检查分两层：文档级看定位、读者、适用范围、版本与关联文档；章节级看目的、前提、步骤、示例、异常与来源，两层不重叠。
- 每项检查都要配可观察的通过标准、证据形式和负责人，避免用“内容完整”“表达清晰”这类无法核对的判断。
- 阻断项决定能否发布：缺少适用对象、关键步骤缺失、示例与正文矛盾、无来源的关键结论，修复并复核关闭后才能发布。
- 清单在初稿完成、评审会前、发布前和定期复审四个时点使用，作者、评审人、知识库管理员分工不同。
- 清单本身需要版本化，文档结构规范调整后同步更新检查项，复审时重新执行。
谁在什么时点用这份章节要素清单
这份清单是核对工具，针对具体文档逐项判断通过与否。把它当写作建议泛读，检查就会退化成印象打分。使用前先确认三件事：检查的是哪类文档、由谁执行、在哪个节点执行。
不同角色在同一份清单上承担不同任务。作者自检侧重在提交评审前把明显缺项补齐；评审人复核侧重验证证据是否真实、判断是否成立；知识库管理员在入库前把关文档级要素和维护信息。三个角色共用一套检查项，但关注顺序不同。
| 角色 | 使用时点 | 检查范围 | 产出 |
|---|---|---|---|
| 作者 | 初稿完成、提交评审前 | 文档级与章节级全部检查项，先自查阻断项 | 自检记录与待补清单 |
| 评审人 | 评审会前预读、评审会中 | 重点复核通过标准与证据，确认阻断项是否关闭 | 评审意见与通过/退回结论 |
| 知识库管理员 | 发布前、入库前 | 文档级定位、版本与复审信息，引用与关联文档有效性 | 入库确认或退回记录 |
| 文档负责人 | 定期复审、内容变更后 | 全量复查，重点看前提、步骤与示例是否随业务变化失效 | 复审记录与更新版本 |
时点上要区分“初稿完成”和“发布前”两轮。初稿轮允许建议项暂挂，阻断项必须清零才能进入评审；发布前轮确认所有阻断项关闭、建议项有处理结论，并核对版本号与更新日期已登记。
文档级要素检查项
进入章节之前，先判断整篇文档能否让目标读者找到它、判断它是否适用。文档级缺项会连带章节检查失去意义，例如适用范围没写，章节里的前提条件就无从对照。
| 检查项 | 通过标准 | 证据 | 负责人 |
|---|---|---|---|
| 标题与文档定位一致 | 标题能指向具体对象和动作，读者看标题可判断文档用途 | 文档首页标题与摘要 | 作者 |
| 目标读者与适用场景写明 | 明确写出角色、使用场景和读者需具备的基础 | “适用对象”段落 | 作者 |
| 适用范围与不适用范围界定 | 两类范围均有具体条目，边界可对照判断 | “适用范围”段落 | 作者、评审人 |
| 版本、作者、更新日期、复审周期登记 | 四项信息齐全，复审周期有明确时间或触发条件 | 文档信息区或页脚 | 文档负责人 |
| 相关文档与前置阅读给出名称或位置 | 每篇关联文档可定位，前置阅读标明必读或选读 | “相关文档”列表 | 作者 |
文档级检查最容易漏的是“不适用范围”。只写适用什么，读者遇到边界情况仍要自行猜测。把不适用情形写成条目，例如“本文不覆盖多环境部署”“本文不适用于旧版本接口”，能直接减少误用。
章节级要素检查项
章节级检查回答一个问题：读者只读这一章，能否独立理解并照着做。逐章执行，每项记录证据所在位置，例如段落编号、截图或示例文件。
| 检查项 | 通过标准 | 证据位置 | 负责人 |
|---|---|---|---|
| 章节目的一句话说清 | 章节开头有目的句，说明本章解决什么问题 | 章节首段 | 作者 |
| 前提条件、输入与角色交代 | 列出执行前需具备的权限、数据、环境或前置章节 | “前提”小节 | 作者 |
| 操作步骤或规则条目可执行、可判断 | 每步有动作对象和完成标志；规则条目有明确判定条件 | 步骤列表或规则表 | 作者、评审人 |
| 示例与正文步骤一致 | 示例中的参数、顺序、结果与正文对应，无矛盾 | 示例代码或操作截图 | 评审人 |
| 异常情况、边界条件与限制说明 | 列出常见失败情形、边界值和已知限制，并给出处理方式或提示 | “异常处理”或“注意事项” | 作者 |
| 结论或判断的依据与来源标注 | 关键结论附来源、测试记录或决策记录，可追溯 | 引用标注或脚注 | 作者 |
“可执行、可判断”是章节级检查的核心口径。写“配置好相关参数”无法判断是否完成，改成“在配置文件中设置超时时间为 30 秒，保存后重启服务，日志出现 started 即完成”，评审人才能核对。示例与正文不一致属于高频问题，常见于正文改了参数而示例未同步，检查时应对照同一组输入逐项比对。
来源标注不必每句都加，但影响读者决策的结论必须有依据。例如性能数据、兼容性结论、合规要求，应标明测试环境、版本或制度文件名称。没有来源的关键结论在下一节会被列为阻断项。
通过标准与证据留存
检查项只有配上可判定的通过标准，才能避免“内容完整”“表达清晰”这类无法核对的表述。通过标准的写法遵循三条：描述可观察的现象、指明核对位置、给出明确的判定条件。
- 可观察：标准描述读者能看到的内容，例如“章节首段包含一句目的说明”，而非“目的明确”。
- 可核对：指明在文档哪个位置核对，例如“适用范围段落列出至少两条不适用情形”。
- 有判定条件：给出数量、格式或对照关系，例如“示例参数与正文步骤表逐项一致”。
证据形式按检查项选择，常用四类：文档链接（指向被检查段落）、截图（界面状态或配置结果）、评审记录（意见与结论）、示例文件（可运行的样例或附件）。证据由执行检查的人在提交评审时一并附上，保存在文档关联的评审记录或附件区，保留期限与文档复审周期一致，至少覆盖到下一次复审完成。
| 检查项 | 通过标准示例 | 证据 | 负责人 |
|---|---|---|---|
| 前提条件交代 | “前提”小节列出权限、数据、环境三类条件各至少一条 | 段落链接 | 作者 |
| 示例一致性 | 示例输入输出与正文步骤表逐项对应，无参数差异 | 示例文件与对照截图 | 评审人 |
| 来源标注 | 性能与兼容性结论均附测试环境、版本或制度文件名称 | 引用标注截图 | 作者 |
不通过时记录三样内容：未通过的检查项编号、具体缺什么、返工责任人与期限。返工完成后由原检查人复核，复核通过才更新检查状态。记录方式统一，避免口头确认导致复审时无法追溯。
在协作工具中执行时，检查记录需要和文档版本对应。ONES Wiki 支持页面模板库一键创建制式化文档，文档实时同步并记录所有页面版本、支持查看与回滚，成员可在线添加注释和评论；评审人可据此在对应版本上留下检查意见，作者修改后对照版本差异复核，检查结论与文档版本保持可追溯。
阻断项与完成条件
把所有检查项同等对待，会导致文档因措辞问题反复退回，或带着关键缺陷发布。阻断项与建议项分开管理：阻断项不关闭不发布，建议项需有处理结论，可以延后但要有记录。
| 类别 | 示例 | 处理要求 |
|---|---|---|
| 阻断项 | 缺少适用对象；关键步骤缺失或顺序错误；示例与正文矛盾；无来源的关键结论；适用范围与不适用范围均未写 | 发布前必须修复并由检查人复核关闭 |
| 建议项 | 措辞优化；补充延伸阅读；增加非关键截图；统一术语大小写 | 记录处理结论：采纳、延后或明确不采纳及理由 |
整体完成条件写成可判定的状态：全部阻断项关闭并有复核记录；建议项逐条有处理结论；文档级信息（版本、作者、更新日期、复审周期）已登记；检查表本身已归档到对应版本。四项同时满足才可发布。
复审与变更后需要重新触发检查。触发条件包括：文档内容发生影响步骤或结论的修改、关联系统或流程变更、到达登记的复审周期、读者反馈指出无法按文档完成操作。重新检查时至少覆盖文档级全部检查项和发生变更的章节，阻断项判定标准不变。清单本身也应随文档结构规范调整同步更新版本，避免检查项与实际模板脱节。
常见问题
文档级检查和章节级检查能不能合并成一张表？
可以放在同一份文件里，但建议分两段执行。文档级检查针对整篇文档的定位与维护信息，章节级检查针对每个章节内部要素，两者的核对对象和负责人不同。合并成一张表时，先完成文档级全部项目再进入章节级，否则适用范围没界定，章节里的前提条件就缺少对照基准。
建议项一直不处理，会不会影响文档发布？
建议项不阻断发布，但需要有处理结论：采纳、延后或明确不采纳并写明理由。延后的建议项应记录责任人和计划处理时点，在下次复审时一并核对。如果建议项长期挂起且无人跟进，说明检查记录没有和复审机制衔接，需要把建议项清单纳入复审范围。
文档内容发生小改动，需要重新跑一遍完整清单吗？
按改动影响范围决定。改动涉及步骤、结论或适用范围时，至少覆盖文档级全部检查项和发生变更的章节；仅修正错别字或格式时，可只核对变更处与示例一致性。触发重新检查的条件包括：影响步骤或结论的修改、关联系统或流程变更、到达登记的复审周期、读者反馈无法按文档完成操作。
检查证据保存在哪里，保留多久比较合适？
证据随文档一起保存，放在文档关联的评审记录或附件区，形式可以是段落链接、截图、评审记录或示例文件。保留期限与文档复审周期一致，至少覆盖到下一次复审完成。使用 ONES Wiki 时，文档实时同步并记录所有页面版本、支持查看与回滚，评审意见可以留在对应版本上，作者修改后对照版本差异复核。
清单里的检查项应该由谁来维护更新？
由文档负责人或知识库管理员维护，与文档结构规范的调整同步。更新触发点包括：模板结构变化、复审中发现高频缺项、读者反馈集中指向某类问题。更新后记录版本号和变更说明，并在下一次复审时按新版本执行，避免检查项与实际模板脱节。
