到目前为止,您应该已经组织好了您的文档;您收集了原始信息片段并将它们插入到大纲中。您接下来的挑战是将您收集的所有原始数据整理成可读、有趣且易于理解的整体。如果您正在处理现有文档,请确保所有新的信息都放在最佳位置。
为了到达真正开始写作的阶段,您已经做了相当多的工作,不是吗? 好吧,现在辛勤的工作开始为您带来回报。在这个阶段,您可以开始真正运用您的想象力和创造力来传达这些大量的信息。 不过,不要太聪明! 您的读者已经在努力理解新概念了——不要让他们也费力理解您的语言。
有很多经典的写作指南——其中许多可以在网上找到。 它们的语言可能看起来很老旧,但这些信息对于今天的作者来说仍然很有价值。 这些在 . 中列出。 资源部分还列出了许多提供特定于技术写作信息的网站。
如果不提及 Plain Language 运动,《作者指南》就不完整。 虽然旨在简化政府文件,但 Writing user-friendly documents 非常有用。 它包括写作范例的前后对比。 还有一个 PlainTrain writing tutorial。
任何讨论为 Web 写作的文档,如果不提及 useit.com 都是不完整的。 以下文章可能特别有趣
有很多很多关于编写 Web 文档的资源——快速 Web 搜索 "web writing" 将找到大量资源。 不过,不要太分心:最终目标是写作,而不是阅读关于写作的内容!有许多行业风格指南定义了如何在文档中使用语言。 美国英语的一个常见例子是 Chicago Manual of Style。 它定义了诸如:句点 (.) 应该在 "引号" 的内部还是外部;以及引用另一个文档的格式。 风格指南有助于保持文档的一致性——大多数公司都会遵循风格指南来格式化媒体发布和其他宣传材料。 风格指南也可以定义单词的拼写方式(是 color 还是 colour?)。
LDP 不要求特定的风格指南;但是,您应该在整个文档中使用一致的风格。 您的文档应该针对单一语言进行拼写检查(例如,美式英语与英式英语)。 Reviewer's HOWTO 目前列出了 LDP 文档的许多约定,并且它尽可能接近官方 LDP 风格指南。
![]() | 个人词汇表 |
---|---|
在您刚开始研究和编写文档时,列出您不熟悉的术语列表会很有帮助。 您可以在编写文本时参考此列表。 您可能还希望将其作为词汇表包含在最终文档中。 |
如果您提前决定如何编写文档,则可以在编辑阶段节省大量时间。 如果您要接手别人的文档,您可能需要:修改您自己的风格以适应当前文档;或编辑文档,使其与您以后想要使用的风格相融合。
从写作风格的角度来看,在 HOWTO 中使用第一人称增加了其魅力——这是大多数其他文档严重缺乏的属性。 不要害怕为自己说话——使用 "我" 这个词来描述您的个人经历和观点。