10.3 文档评审流程
文档评审是保障文档质量的关键环节，通过多轮评审可以发现并纠正内容、格式和技术方面的问题。
R-166
必须
文档发布前必须经过至少一轮评审
所有对外发布的技术文档在发布前必须经过至少一轮正式评审。评审应有明确的评审标准和检查清单，评审意见应记录在案。未经评审的文档不得发布。紧急情况下可以简化评审流程，但不得完全跳过评审环节。
评审流程概述
完整的文档评审流程包含四个阶段：
- 自审：作者完成初稿后进行自我检查，使用评审检查清单逐项核对，修正明显的错误和遗漏
- 同行评审：由团队内的其他技术写作人员进行评审，重点关注语言质量、格式规范和内容组织
- 专家评审：由相关领域的技术专家（如开发人员、产品经理）进行评审，重点验证技术内容的准确性和完整性
- 终审：由文档负责人或质量保证人员进行最终审核，确认所有评审意见已处理，文档达到发布标准
每个阶段的评审意见应通过统一的评审工具或表格进行记录和追踪，确保所有问题得到妥善处理。
评审检查清单
| 检查项 | 评审要点 | 评审者 |
|---|---|---|
| 术语一致性 | 全文术语使用是否统一，是否符合术语表规范 | 技术写作人员 |
| 格式规范 | 标题层级、列表格式、代码样式是否符合风格指南 | 技术写作人员 |
| 技术准确性 | 操作步骤、参数说明、代码示例是否正确可用 | 开发人员 |
| 语言质量 | 语句是否通顺，有无错别字，标点符号是否正确 | 技术写作人员 |
| 图片与标注 | 截图是否清晰，标注是否准确，替代文本是否完整 | 技术写作人员 |
| 链接有效性 | 内部链接和外部链接是否可正常访问 | 技术写作人员 |
| 可访问性 | 是否满足 WCAG AA 级标准，表格和图片标记是否规范 | 质量保证人员 |
| 版本信息 | 版本号、日期、适用产品版本是否标注正确 | 文档负责人 |
评审周期应该多长？
评审周期取决于文档的篇幅和复杂度，一般建议：
- 短文档（5 页以内）：每轮评审 1-2 个工作日
- 中等文档（5-30 页）：每轮评审 2-3 个工作日
- 大型文档（30 页以上）：每轮评审 3-5 个工作日
完整的评审流程（自审 + 同行评审 + 专家评审 + 终审）通常需要 5-10 个工作日。在项目计划中应预留充足的评审时间，避免因时间紧迫而压缩评审环节。
评审意见有分歧怎么办？
当评审意见存在分歧时，建议按以下步骤处理：
- 理解分歧：首先确认双方理解一致，很多分歧源于对评审意见的误解
- 依据标准：以风格指南和行业标准为依据，看哪种方案更符合规范要求
- 用户视角：从目标读者的角度评估哪种方案更有利于信息传达和理解
- 升级决策：如果仍无法达成一致，提交文档负责人或团队负责人做最终决定
所有分歧及其解决方案都应记录在评审记录中，作为团队知识积累的一部分。
紧急发布时可以跳过评审吗？
原则上不允许跳过评审，但紧急情况下可以采用简化评审流程：
- 快速评审：将同行评审和专家评审合并为一轮，由一名资深写作人员和一名技术专家同时进行
- 重点评审：仅对变更部分进行评审，跳过未变更内容的检查
- 事后补审：紧急发布后，在下一个工作日安排完整评审，发现问题后及时更新发布版本
所有采用简化评审流程的发布都应在发布记录中注明原因，并确保事后完成完整的评审和修正。