5. 技术准确性审查

确保文档中陈述的事实是正确的、有帮助的且与主题相关的。

要进行技术准确性审查,你确实需要了解你的主题,可能要和原作者一样好甚至更好。 使用任何可用于你的主题的其他文档,包括 man 手册、程序文档、其他印刷书籍等。 你也可以使用关于该主题的邮件列表,要求第三方验证你存疑的某些事实。

在进行此类审查时,请考虑信息是否仅对某些类型的硬件或软件有效。 如果是这种情况,请务必在文档中注明文档的局限性,可以在摘要中或文档开头的注释中注明。 例如,如果文档中的解决方案仅与一种类型或品牌的硬件相关,请确保定义该限制。 这将防止读者尝试将某种类型的技术应用于不适用的应用程序或情况。

同样的原则也适用于读者的先决知识。 如果假定或需要事先了解某个主题,作者应在文档开头某处说明,并且要求作者提供“资源”部分以供进一步阅读是有帮助的,以便使读者更接近所需的信息。