写作对于技术人来说是最好的投资

上周日参加了腾讯云开发者社区和墨问西东组织的技术创作特训营活动，今天复盘一下。

虽说是技术创作特训营，现场到场的超过半数也都是技术人，但是分享的内容并不局限于技术人。

这次分享包括四个部分的内容，四个部分内容是一个体系，包括为什么要写作？怎么让读者能读进去？怎么锻炼提升写作能力？怎么写好技术文章？写作对职场有什么帮助？

我们来一一拆解。

一、怎么写出让读者能看进去的文章？

1、内容，言之有物

用最少的语言描述清楚一件事情，而不是最多。

要学会做减法，把自己想要表达的东西用最直接的方式写出来，删除所有不需要的东西。

2、格式，简洁美观

屏幕阅读和纸质书阅读差别很大，现在通用的做法：

1、首行不锁进；

2、中文和英文、数字之间增加一个空格；

3、段落之间多增加一个空行。

4、每一段话，不要超过 5 行。

3、言之有物

上一部分是门面，如果你排版不好，所有文字都挤在一起，那不管内容多好，都不会有人愿意读。

这一部分是建立在你排版 OK 的情况下，你的内容应该要有价值，要言之有物。

4、不要有知识性错误

知识性错误会导致读者对你的信任骤降，严重损害读者心中的形象。

5、用最少的字把事情说清楚，而不是最多

珍惜用户的时间，500 个字能说清楚的事情，不要写 1000 个字。

自己写完的东西要读三遍，做到至少没有语句不通顺、阅读不顺畅。

二、怎么锻炼自己的写作能力？

着眼当下，了解清楚，自己身边所有事情的来龙去脉。

举个例子：

你要写一篇长城游记。你可以去了解，为什么要建造长城？为什么要选择这个位置建造长城？建造长城有哪些成本？建好之后有什么作用？

三、怎么把技术文章写好？

1、能把别人教会，你才是真的懂

很多人不管是听课还是看书，都是看完、听完了事。自以为都懂了，但是你让他给你讲一遍，你发现他根本说不清楚。

甚至有些职场所谓的领导，为了在老板面前表现自己，领导说什么，都说自己明白了。但是，当你真正去找他了解的时候，他又说不出所以然。

只有你能把别人教会、讲明白，你才是真的懂！

2、没有自己的思考，只是复制粘贴代码

这个主要发生在技术人身上，很多人写技术文章，尤其是在 CSDN 平台上，你能发现很多这样的人，一篇文章大部分都是代码，意思让你自己领悟，好像谁不会看代码似的！

技术文章，除了贴代码，一定要有自己的思考，这段代码为什么这么实现？这么实现有什么好处？有没有更好的实现方式？

3、技术枯燥无味，学会用「比喻」

技术文章很容易让人读起来毫无兴趣，怎么让人有兴趣读完你的内容？学会用比喻，讲故事。

比喻和故事能让人更容易记住技术的原理。这里说一句老师的原话：

比喻有相似、夸张之处，相似是为了记住原理，夸张是为了记住关键差异。

就说 k8s 和 docker，你怎么给一个外行解释这是一个东西？官方就是使用比喻的方式，k8s 就是一个装满集装箱的邮轮，这个集装箱就是 docker。

4、学会讲发展史

一段原文

某项技术的应用场景源于设计的原始初衷，而原始初衷是从历史上的痛点发展过程中来的。
复杂的技术是很难讲清楚的，但是无论多么复杂的技术体系，都是从简单的应用场景逐渐演化来的，从发展历史角度来看，脉络就会很清晰

你去看淘宝的技术架构，你会发现它很复杂，但是如果从历史角度来分析。它的复杂度都是根据历史进程演化而来的，淘宝刚开始只是一个从网上买过来的单体架构。只是因为业务的发展，逐渐演化成这样的。

四、怎么让写作助力职业发展？

职场过程中，就算是程序员，也是离不开写作的。

你的技术文章、周报、月报、项目总结汇报、项目立项文档、试用期 PPT、晋升答辩 PPT 等等。

这些东西都离不开你的写作能力，而且，大部分程序员都是闷头做事，但是很难把自己做的事情讲清楚，白白吃了亏。如果你是一个写作能力优秀、表达能力优秀的程序员，那你的优势会非常大！

一个优秀的写作者，不仅能让复杂的事情变得容易理解，而且能够换位思考，实现更顺畅的沟通，更好的助力职场发展。

写作是最好的投资！