7、技术信息写作：准确性与完整性的关键准则

技术信息写作：准确性与完整性的关键准则

在技术信息写作中，准确性和完整性是至关重要的两个方面。准确的信息能让用户信赖并有效完成工作，而完整的信息则能确保用户获取到所需的全部内容。下面将详细介绍确保技术信息准确性和完整性的关键准则。

准确性准则

为保证技术信息的准确性，可遵循以下几个方面的准则：
|准则|具体要求|质量评级（1 - 5，1为非常满意，5为非常不满意）|
| ---- | ---- | ---- |
|只写自己理解并核实过的信息| - 程序正确，用户按步骤操作能达到预期效果
- 描述性信息准确|1 2 3 4 5|
|紧跟技术变化| - 最终信息包含产品的最新变化
- 网页信息更新频率可接受
- 商标列表为最新状态
- 前版信息保持最新且有效
- 界面描述与实际界面一致
- 对特定产品的引用为最新|1 2 3 4 5|
|保持所有信息的一致性| - 重复信息保持一致
- 相关主题间无冲突，如示例输出与实际输出匹配，图形和示例与支持文本一致，指南和规则的示例准确|1 2 3 4 5|
|使用自动检查准确性的工具| - 示例、语法描述、程序等信息无拼写错误
- 文本无语法错误|1 2 3 4 5|
|检查相关信息引用的准确性| - 交叉引用正确
- 引用信息包含相关内容
- 引用中的标题和序号准确|1 2 3 4 5|

在审核技术信息准确性时，可将第73页的检查表作为提醒工具，确保全面审核；也可作为评估工具，确定信息质量。根据检查表第三列的质量评级对准则整体进行评估，将评估结果添加到第387页的“质量检查