Writing for Engineers（作为工程师应该如何写作） —— Stemwede

Posted 2023-06-19 CrazyPixel

本文对一篇外文的工程师写作指导进行提炼总结，介绍了工程师写作中需要注意的一些技巧，值得立志成为工程师的小伙伴阅读

目录

• 1. 写作前
  • 1.1. 有好的信息
  • 1.2 写作不是学习
  • 1.3 了解你的受众
  • 1.4 做好准备
  • 1.5 趁热打铁
  • 1.6 快速进入一个主题中
• 2. 写作时
  • 2.1 提纲挈领
  • 2.2 内容优于润色
  • 2.3 让文字可以略读
  • 2.4 提供摘要
• 3. 写作练习
  • 3.1 持续写作
  • 3.2 利用小型写作任务作为练习
  • 3.3 首先获得大纲反馈
  • 3.4 向选定的听众展示文章草稿
• 4. 技巧总结
• 5. 参考博客

1. 写作前

1.1. 有好的信息

如果感觉无话可说，那么首先要做到去接触某一个主题，找到自己感兴趣的的信息。

1.2 写作不是学习

写作能够测试自己对某个主题的理解和掌握，是一种输出形式，但是作为学习方式来说较为低效，不如阅读、看视频、看博客效率高。

1.3 了解你的受众

想象一个具体的人，向他解释一些东西，需要准确了解受众的需求。

1.4 做好准备

写作需要长时间的集中精力，因此需要做好准备，避免分心。

1.5 趁热打铁

刚刚完成某一任务之后，自己写作的时候，能够清晰描述背景，回忆细节，写作效率更好。
所以在两个任务之间，可以尝试对上一任务进行写作。

1.6 快速进入一个主题中

上下文（背景知识）的加载需要付出精力，为了实现上下文的加载，可以尝试：

• 查阅自己关于这个主题的笔记；
• 和朋友、同事聊这个话题；
• 阅读这方面的书籍、博客、论文。

2. 写作时

2.1 提纲挈领

写作之前，可以先列出提纲，然后再进行填充，这样可以避免写作过程中的分心，也可以避免写作过程中的遗漏。
大纲是作者和读者都有目共睹的文章脉络，就像故事线一样，是很重要的文章组成部分。写一篇文章应该先写大纲，然后再填充内容。

2.2 内容优于润色

在写作的时候，我们容易被文章格式、博客风格、部署文章的问题干扰，
但是在完成内容之前，这些都是无关紧要的事情，确定大纲之后，第一步就是完成自己的文章内容，确定没问题之后再操心后续的风格润色和文章部署。

2.3 让文字可以略读

在网站上，用户的注意力很短，需要短时间内展示文件价值，把大纲、关键内容设置在突出位置。提供章节标题和列表

2.4 提供摘要

总结文章内容，交代背景，总结论文。
在写作的最后再总结摘要。

3. 写作练习

3.1 持续写作

培养写作能力，重视数量而非较高的质量，每周都坚持输出。

3.2 利用小型写作任务作为练习

写短文档练习写作技巧，例如电子邮件等等。

3.3 首先获得大纲反馈

在完成大纲、完善故事线之后，可以对文件获得初步反馈，从而尽快发现故事线缺陷，避免在写作过程中浪费时间。

3.4 向选定的听众展示文章草稿

初稿完成之后给目标受众人员，获得反馈，审视自己的工作。

4. 技巧总结

• 有主题可写。
• 写作作为输出方式，是学习过程的一次总结。
• 趁热打铁，在一个任务完成后进行总结，这样能记住更多的细节。
• 内容中最重要的是大纲，先构建大纲再开始写作。
• 先完成任务再考虑润色、出版、部署等问题。
• 展示自己文章的核心，在文章最后写摘要，从而保障用户快速了解这篇文章的价值。
• 持续写作，重视数量而非质量。

5. 参考博客

参考博客-1