工程师的非技术指南（2）——大量写作（上）

成为一个好的写作者，不管是通过邮件写作，还是通过文档写作，都能让你更有影响力。很多工程师都忽略了这一个技能，他们也许会对自己写的代码感到骄傲。对工程师来说，写作是一个被低估的技能。   ——-Urs H lzle  前google软件工程副总裁

如果我们想在我们的软件工程师职业生涯有所作为，我们应该像重视编写代码一样重视文字写作，建立一个高产出的写作习惯。工程师经常低估写作的重要性，投资于这项技能，提升你传达信息的能力，成为有影响力的工程师。

工程师为什么要写作？

工作需要

日常工作中有大量地方需要写作

1. 邮件沟通。

2. 编写方案设计文档，代码和入请求文档。

3. 需要撰写项目申请建议书，申请项目立项，向上级部门解释支持我们立项的好处。

4. 出现重大事故时，需要撰写事故分析报告，给上级部分和客户做解释，说明事故的影响程度和解决方案。

5. 写晋升报告，给同事们写评价。

6. 客户沟通文档，客户指导手册

7. 提案和决策，编码准则，最佳实践、经验教训，运维手册，调试指南。

我们工作中60%-70%沟通都是书面沟通，特别是远程工作时，利用书面沟通代替面对面的语言沟通。我们要鼓励书面沟通的文化，在团队中推广写作的好处。

大多数软件工程师专注于成为优秀的代码编写者。成为优秀的代码编写者是软件工程师的必要成长路径。然而，成功的公司会不断成长，软件工程团队将超过几十人甚至上百人，分散在各个不同的site，面对面的沟通变得不够，需要高效的书面沟通。

在一个大型组织中，写作变得重要，以便让信息传达给更广泛的人群。对于软件工程师来说，写作成为与其他工程师和团队进行交流和构建影响力的工具。写作变得必不可少，我们的想法，决策和解决方案可以持久的记录下来。将这些内容记录下来，分享我们学习到的知识，指导别人按照你写的文档来操作。构建自己影响力的同时也帮助了别人，这是一个正和游戏。

超越工程师生涯

有些工程师写的文档比他们写的代码要多得多，他们比只会写代码的人获得了更大的影响力。通过良好的写作，可以扩展你跟多个团队，一个组织和整个公司有效沟通的能力。沟通能力和影响力会让你超越你当前的团队，是初级工程师进阶到高级工程或者团队管理者不断增长的基本技能。

无论你是一位管理者需要管理团队，还是一位创始人想去筹集资金，当我们想超越我们的工程师生涯时，对优秀的写作能力要求会越来越高。

可以把写作想象成缓存你自己，你自己就是一个数据库，随着时间的成长，数据库无法响应所有请求，所以需要增加缓存，写作是缓存，文档是缓存。

文档写作

文档写作是工作的写作，我们自己编写的程序，要写设计文档，要写用户指导文档，有时候还要求我们写新员工入职指导文档。

很多优秀的公司遵循文档驱动的开发，在解决方案文档没有达成一致之前，不允许编写代码。亚马逊的贝佐斯有个著名的六页记（six pager)，通过六页文档，描述项目发布当天的样子，开始倒推我们需要做的工作，在亚马逊进行任何项目之前，必需有六页文档能通过审核。

清晰、逻辑严谨、令人难忘的写作技能与构建一家能够不断为客户提供价值并不断自我革新的公司所需的技能是相同的。贝佐斯是亚马逊的首席写作传道者，他对长篇写作艺术的倡导作为一种激励工具和创造力想法的生成技巧，在过去的二十年里改变了亚马逊的思考和工作方式，尤其是在公司创造新想法、分享想法以及从更广泛的世界获得支持方面。

个体思考创造性问题时比群体更出色，而且邀请批评和分析对创造力有益。写六页备忘录迫使他的团队以高分辨率的细节思考他们的想法。它使得人们提出的观点中的任何逻辑矛盾都无法隐藏起来。通过在亚马逊的观点生成过程中强制使用严格的、标准化的模板，杰夫·贝佐斯提高了标准，提升了团队思考的质量。

编写优秀的技术文档对于各类软件公司都至关重要，技术写作是一个很深入的学科，google有一个很好的技术写作课程：，大家可以继续学习。https://developers.google.com/tech-writing^[1]

职业生涯写作

大多数开发人员都不公开写作，他们的很多作品都放在公司的服务器上。我们要明白，我们的职业生涯要比我们待在任何一家公司都要长，我们要想在业内建立专业知识和声誉，需要用自己的名字来公开写作。

为自己的职业生涯写作有一个好的方法是在顶级的行业博客和论坛上发表文章，这些地方有时会付费让你写作，你在赚钱的和获得追随者的同时，还能练习自己的写作技术。但是为其它平台写作我们会失去版权（因为已经付费了）。但是在早期，让我们能获得更大的影响力比版权更重要。也可以在已经建好的平台，比如stackoverflow。

个人技术博客是无需许可的写作形式，开源你的知识，在你公开学习时找到你的追随者和同行者，你是在建立自己的品牌。

我们想做一个开源项目，也需要市场推广，也需要写博客文章，也需要制作视频，在社交媒体上宣传，接触有影响力的人协助做推广。如果你有一个个人品牌，你会更容易推广你的开源作品。

我们能从写作中获得什么？

写作不仅仅是为了交流思想，写作过程中也能产生想法。——保罗 格雷厄姆

写作是为了去创造内容，而不是消耗内容。他可以给你可扩展性，结构和力量。

可扩展性

写作的影响力是无限的，规模也是无限的。现代文明起源于古腾堡印刷机的发明，印刷机让书籍文字的低成本复制印刷成为可能，引发了伟大的文艺复兴，优秀作家的作品可以流芳百世。计算机的发明将文字数字化，复制文本的成本降低到零。互联网的发明可以让伟大的作品在几秒钟内传播到全世界，这是人类历史上第一次，伟大的作品可以像病毒一样传播。当你写作时，你可以无限扩展你的想法，你的影响力，还有你自己。

搜索和存储是大脑擅长的东西，但大脑的容量也是有限的。我们要尽可能把大脑的记忆卸载到计算机上，数字化写作是可以存储的，也可以随时检索，写作是存储这些信息最好的方法。你还记得5年前的自己做了什么，大脑可能不记得了，但是你的日记里面会有。

写作可以控制你的叙事权，对于不认识你的人，你的网络状态是他们在google 或baidu上检索到的。如果在google上可以检索到你写的优秀的文章，大家会对你产生更好的印象。如果你不在网上写东西，别人检索你的时候，会出现你无法控制的东西。

结构化

大脑不擅长的事情是，把一些松散的想法组合成一个模糊的结构。写作可以组织你的想法，当你写作时，你必须先组织一个顺序，注重关键的想法，也可以链接到原始来源，读者也可以根据意愿来跟进阅读。

写作是忙碌大脑的冥想。写作可以整理你的大脑，你可以写下来一个问题的所有解决方案，写作迫使我们检查所有的方案是否都符合逻辑。经过深思熟虑的写作的结果比草率的决定要好很多。

写作会让你更聪明。一个有条理的头脑比没有条理的头脑更聪明，因为大脑缺乏结构，我们需要通过结构化来整理大脑，组织我们的想法。写作也可以帮助你在没有准备的情况下演讲，我们经常看到演讲者口吐金句，他很可能提前已经写下来了。

动力

写作可以低成本探索你的想法。我们很容易把写作内容拆分，重新组织自己的思路，编辑的成本很低，可以短短几句话勾勒出一个完整的框架和商业计划。我们也可以提出假设，考虑各种极端情况，但是我们不一定要去实施，我们可以低成本的探索自己的想法。

写作是抽象的，你可以传达还不存在的各种感觉，概念，和故事。写作的内容可以不受现实的约束，自己发挥我们的想象力。

写作会缓存你的输入。思想，信息和学习以非连续的方式自然发生，你的当下的想法随时随地写下来，先缓存到笔记系统中，在我们需要的时候来基于以前记录的想法来创作。

写作是不需要许可的。伟大的想法一旦被记录下来，在任何地方都可以找到，如格雷厄姆所说：任何人都可以在网上发表文章，网络是这个时代成为散文的黄金时代。

如何成为一个优秀的写作者？

我们不需要成为一个伟大的作家，只需要成为一个好的写作者。

起步

要想成为一个公开的写作者，我们可以从下面3个地方起步：

1. 有一个地方写：可以使用notion或者onenote，可以跨平台使用，电子写作可以更快捷的编辑，复制和检索和转发。

2. 找时间写：我们会花大量时间读书（文章），看视频，听播客，要花时间写下来你学到的东西，否则90%内容一段时间就会记忆中消失。有一个基本原则，不写作就不要学习。

3. 当有疑问时，不要发表：当我们有疑问时，暂时先不要发表，我们的最终目标是建立写作的习惯。

写什么

我们写的内容，不必是一个专家写的内容，我们如果有担心可以放一个免责声明，说明你做了什么主题研究。如果你写错了，让互联网上同行来纠正你，慢慢你也会成为专家。

我们会觉得缺乏写作的想法，可以从下面四个方面开始：

1. 写下来你学习东西的总结：比如你读的书籍，博客，听过的播客，看过的视频等。

2. 写下你标准工作的流程：比如说我是怎么度过这一天，我是如何学习的，我们如何健身的。

3. 写下你解决的问题：软件bug的解决流程，系统性能优化的有趣故事。

4. 寻找他人问的问题，用自己的话来回答。

写新闻的诱惑力很强，但是他的半衰期很短。要选择长期有价值的话题来写作，让自己和读者从林迪效应中受益。

怎么写

写作会节省你的时间。你读过的内容，学过的知识，通过写作记录下来，可以巩固你的记忆，加深你的理解，当我们再次用到时候可以引用它。当别人来问你问题时，你可以把你写的文章丢给他，节省你的时间，你只需要写一次你的解释。

文档（工作）写作可以参考亚马逊的六页纸，主要格式如下：

1. 目的：概述原因，并在本节中提出一个推荐的解决方案，通常是一个简洁的段落。

2. 叙述：描述背景和总体框架，让每个人都能充分理解问题。应该从目标人群/客户/用户的角度来讲述，而不是从业务决策者的角度。

3. 问题：详细描述问题。

4. 解决方案：包括多种解决问题的方式。重要的是以客观的态度来书写，避免偏见，让每个人都能真正客观地看待这种情况。

5. 建议：根据解决方案，提出有理由的建议方案。

6. 行动计划：如果可能的话，假设提议的解决方案得到同意，添加一个行动计划。

公开的写作模板：

1. 讲述一个引人入胜的故事

2. 把他和你的个人经历联系起来

3. 提出一个解决方案

4. 实用的操作技巧结束

精简写作方式：精简写作是指将一小段内容扩展成更长的形式。

• 一条推文

• 一篇原子文章

• 关于Twitter的一系列推文

• 长篇博客

如何提高写作能力呢？如何清晰、简洁、易读地写作呢？和任何技能一样，关键在于了解基本原理、不断练习、接受反馈并持之以恒。推荐从两本书开始阅读：《写作法宝：非虚构写作指南》和《风格感觉：21世纪写作指南》。

重新阅读自己的写作并无情地重新编辑是成为更好的作家的下一步。挑战自己以更简洁的形式传达相同的信息并重新撰写内容。

公开发布

你要努力尝试发表你的作品，让别人读你的作品，纠正你的错误，成为你作品的粉丝。要有耐心，磨炼你的写作，你最终会找到你的最佳状态，坚持足够长的时间，别人会发现你。

接受这样一个事实，每个人都在荒野中徘徊了很长一段时间才找到第一个观众，如著名的写作教练david perell 所说的安静的四个月。可以每周发表一篇博客，连续15周，可能直到16周才被被人注意到，对有人来说可能需要一年才会被注意到。我们可以专注于单一的平台，从微博/推特/微信公众号起步，然后慢慢引导读者到你能控制的个人博客。

创造力就是做事情，把你的写作内容公开出来，不一定是惊人的原创。你所写的东西收到你所读的东西的影响，我们读有趣的内容，输出高质量的内容。写下来每个人都知道但是没有写下来的内容，把复杂的问题简单解释，所有人都会喜欢的，有很多东西没有被写下来，仅仅是因为没人愿意写。有时候读者想对某个主题深入的理解，你可以对这个主题写最全面的内容。互联网会不成比例的奖励质量的内容。

不要害怕重新混合你的写作，可以重新包装现有的作品，把这些想法重新链接，或者重写，对于新的读者来说，你会显得非常有效率。

接受反馈，要想让别人你有兴趣，就要对他人感兴趣，对于读者的反馈，我们要积极的回答，一个一个的建立关系。

持续写作

如纳瓦尔所言：无论世界需要什么，你都可以得到报酬，互联网极大地拓宽了职业生涯的可能性，大多数人还不明白这个道理。互联网让每一个细分市场都摆脱了地理限制，全球支付系统可以服务于每一个细分市场的企业和个人。

我们都可以成为受人尊敬的写作者。

1. 寻找一个兴趣点，找到一个你感兴趣的内容，别人也感兴趣的内容。

2. 写100万字，有意识的学习提高自己，成为这个领域的专家。

为什么是100万字？我们全部的初中级教育（从小学到中学），大约写了100万字让我们从文盲变成了高水平的人。然后你上了大学（特别是文科大学），大约又写了100万字，让我们成为了一个知识工作者。我们只是完成了别人让我们写作的东西，就取得了这么大的成就。根据自己的兴趣，主动的去学习，总结，输出100万字，会取得了不起的成绩。每天写1000字，除去周末，一年是250天，四年就是100万字。

你如何才能学好写作呢？答案只有一个，你要写的很多很多。数量会带来质量，缓慢持续的进步是成就大事的唯一途径。

Nathan barry 在2012年出版他的第一本书之前，只建立一个追随者，并最终创造了9位数的电子邮件营销业务，他承诺每天写1000字。著名博主Tim Ferriss 每天坚持写2页东西。

我们在学校接受的传统的写作建议非常糟糕，他没有要求关注写作中最重要的东西。语法，风格，结构这些都不重要，重要的是我们写的内容能抓住读者的兴趣，能给读者传递了有用的信息。

每天写1000字是个伟大的承诺，需要2-4小时才能完成。但是他对未来的你帮助，我们可以通过下面方式完成：

1. 500字的笔记。记录你读到的，听到的，看到的一切。

2. 250字日记。记录你的精神状态和你的目标。

3. 250字的实际写作。写出来他人可以阅读的文档和博客。

当你承诺每天写1000字时，会发生如下变化：

1. 你会有选择的消费：写笔记和总结需要时间，你看的东西会更加挑剔，当你从消费转成成消费-创造时，你不仅仅是做个被动信息消费者，你会做个主动的信息消费者和创造者。

2. 你会从你写的东西中得到更多：写作帮助你完成学习，帮助你更好的理解学习的主题，提高你的日常工作效率。

3. 你会想要分享它：既然你已经花时间写出来，会想增加你的投资回报率，确保它到达更多的观众。你的目标是通过扩大覆盖面和延长时间来增强你的影响力。

4. 你会引用自己的话：你有这么多的写作，随着时间的推移，你可以写任何特定主题，你的写作变成你的第二大脑。

5. 你不害怕写了：当你需要在工作需要写真正重要的东西时，你不会担心，因为你有更高标准更长时间的长期练习。

6. 你会考虑投资在写作：你会建立一个写作系统，把写前和写分开，也会得到专业的指导和培训。

7. 你的写作能力会越来越好。

你的写作，你的个人品牌，你的事业也是你的孩子，一旦你意识到他是你的孩子，你别无选择，只能坚持做。

参考阅读

《写作法宝—非虚构写作指南）

《风格感觉，21世纪写作指南》

参考资料

[1]

https://developers.google.com/tech-writing: https://developers.google.com/tech-writing

[2]

https://writingcooperative.com/the-anatomy-of-an-amazon-6-pager-fc79f31a41c9: https://writingcooperative.com/the-anatomy-of-an-amazon-6-pager-fc79f31a41c9

[3]

https://www.mad.co/insights/the-mad-six-pager: https://www.mad.co/insights/the-mad-six-pager

[4]

https://developers.google.com/tech-writing: https://developers.google.com/tech-writing

[5]

https://www.kristencorrects.com/the-pillars-of-writing/: https://www.kristencorrects.com/the-pillars-of-writing/

[6]

https://nathanbarry.com/endure/: https://nathanbarry.com/endure/

[7]

https://perell.com/essay/the-ultimate-guide-to-writing-online/#write-from-abundance: https://perell.com/essay/the-ultimate-guide-to-writing-online/#write-from-abundance