Writing for Engineers 是由 Heinrich Hartmann 撰写的讨论 作为工程师应该如何写作 的文章。我读后觉着作者分享的经验和提供的建议,对于希望提高写作技能的工程师来说是很有价值的资源,值得做笔记时不时回看一下。
开始之前
- 有话要说:写作的目的是有效地向读者传递信息。如果信息不明确,写作将变得困难。
- 区分写作与学习:写作过程中可能会发现自己对主题的理解不够深入,这时应该通过研究和学习来补充知识。
- 了解你的受众:了解受众有助于确定使用的专业术语、背景假设和写作风格。
- 尊重你的心态:写作需要长时间的专注,选择一个无干扰的环境和心态良好时进行写作。
- 趁热打铁:当你对主题有充分的理解时,应该立即开始写作。
- 预热:如果没有足够的背景知识,应该先通过阅读笔记、讨论或研究来积累知识。
在过程中
- 从重要的开始,而不是开头:对于超过一页的文档,应该从大纲开始,而不是直接写正文。
- 在充实内容之前固定故事线:在详细撰写之前,应该确定文档的故事线和主要信息。
- 在开始润色之前完成内容:应该先完成所有内容的撰写,然后再进行编辑和润色。
- 使文本可略读:通过使用小标题和列表等来提高文档的可略读性。
- 提供摘要部分:摘要部分为读者提供了文档内容的高层次概览。
练习实践
- 持续写作:通过持续写作来提高写作技能,重视数量而非质量。
- 利用小写作任务作为练习:将电子邮件或问题票等小文档作为练习写作技能的机会。
- 在大纲上获得早期反馈:在完成大纲和故事线后,获取反馈可以帮助发现早期的问题。
- 向选定的受众传阅文本草稿:在完成初稿并进行初步编辑后,向目标受众的几位成员发送文档以获取反馈。
希望你我都能通过参考这些建议更有效地传达自己的思考和想法,从而在大型组织中取得更大的影响力。