Skip to main content

5. 作业一点评

本节，我们将通过考察若干不同风格的应用文习作，来探讨如何将基本技术写作原则应用到实际工作中。

内容规划

内容规划可以说是技术写作过程中最为重要的一步。动笔前，请先利用列表或者思维导图等工具来梳理 文章内容逻辑和架构，尽量使文章架构中的每个节点都是独立、完整、不可细分的整体。

同时，请明确写作的对象和目标：

  1. Who is your audience? Describe them in a few sentences.
  2. What do they want to accomplish?
  3. What is your goal for providing the content?

基本原则

写作过程中，请牢记我们的老朋友《Strunk & White》 的11条法则：

  1. Choose a suitable design and hold to it.
  2. Make the paragraph the unit of composition.
  3. Use the active voice.
  4. Put statements in positive form.
  5. Use definite, specific, concrete language.
  6. Omit needless words.
  7. Avoid a succession of loose sentences.
  8. Express coordinate ideas in similar form.
  9. Keep related words together.
  10. In summaries, keep to one tense.
  11. Place the emphatic words of a sentence at the end.

联合国正式文本

为联合国编写会议记录、决议、决定等正式文件时，需参考以下资料：

凡是指南中没有涉及的内容，均以牛津风格为准。

电子消费产品及互联网领域的文本

关于风格方面的建议可参考微软公司维护的开源资料《Microsoft Style Guide》。 其中关于微软整体文风的小节“Top 10 tips for Microsoft style and voice”尤其值得 细读。

凡是指南中没有涉及的内容，均以 Chicago Manual of Style 为准。

注意

在实践中，应当与客户、团队成员等利益相关方充分沟通，根据项目需要制定可操作的规则。