4.2. 编辑和校对文本

一旦你完成了 HOWTO 文档的文本编写,现在是时候润色和改进它了。 好的编辑可以使 HOWTO 文档从好变得更好。

编辑的目标之一是删除[无关的]材料,这些材料不知不觉地进入了你的文档。 你应该仔细检查你的 HOWTO 文档,并无情地删除任何对读者理解主题没有帮助的内容。 作者在写作过程中跑题是很自然的。 现在是纠正这个问题的时候了。 在你编写文档和编辑文档之间留出一点时间通常会有所帮助。

确保每个章节的内容与标题完全匹配。 你的原始主题标题可能不再相关。 如果你偏离了原来的标题,可能意味着以下情况之一:原始标题措辞不当,新材料实际上应该放在不同的章节中,或者新材料对于你的文档来说不是真正必要的。 如果你需要更改标题,请检查原始主题标题是否仍然重要。 如果是,请确保该主题在文档的其他地方有所涵盖。

在编辑和校对你的工作时,检查明显的错误,例如拼写错误和错别字。 你还应该检查更深层次的、但不太明显的错误,例如信息中的“漏洞”。 如果你正在创建一组指令,在新的机器上测试它们可能会有所帮助。 有时会有需要安装的软件包,而你忘记在文档中提及,例如。

当你对你的工作的质量和准确性完全满意时,将其转发给其他人进行第三方校对。 你会离这项工作太近而看不到根本的缺陷。 让其他人也测试这些说明。 确保他们完全按照你写的内容进行操作。 要求任何测试你的文档的人在他们没有按照你的说明进行操作的任何地方(以及他们没有按照说明进行操作的原因)做具体的笔记。 例如:“我跳过了步骤 2,因为我已经安装了所需的软件包。”

从某种意义上说,编辑就像软件开发中的代码审查。 让程序员审查自己的代码没有多大意义,让作者编辑自己的文档也没有意义。 招募一位朋友,或写信给讨论列表,以找到一位志愿者在提交文档之前进行校对。 你可能还想将你的文档提交到与你的文档主题相关的邮件列表。 列表成员应该能够帮助检查事实、你的说明的清晰度和文档的语言。

Note母语使用者?
 

如果你正在用你不流利的语言写作,请找一位以此语言为母语的编辑。 技术文档比任何其他类型的写作都更必须使用极其精确的语法和词汇。 滥用语言会降低你的文档的价值。