小熊 · 2019年09月28日

写技术文的三个原则是什么?

本文章原创首发于公众号:编程三分钟

我关注了很多技术类的公众号,看着大佬的公众号几千的阅读量,甚是羡慕,这直接导致了我没有心情减肥,甚至多吃了一个鸡腿。

要怎么才能写出一篇好技术文章,让读到的人感到身心舒畅,快速Get到想说的点,我想破了脑袋。

喜欢读我文章的人多少都和互联网行业沾边,像咱们这一行加班是常有的,看文章的时间也比较琐碎:蹲厕所、挤地铁、吃饭、睡前玩手机。基本就是这四个时间,不是正在做就是在去的路上,有木有?!

要在有限的几分钟里,让看的人能够流畅读完,并且掌握表达的点,是一个很有难度的事情。

我总结了一下,重点有三个:

  • 精简
  • 有趣
  • 成体系

精简

  • 精简,就是不说废话,珍惜读者的时间,把注意力集中在关键知识点上,最好在文章开始就能点明主题。
  • 绝不要大段的引用和铺概念,一旦出现这种情况,中间也没夹杂有趣的部分,很容易产生抵触情绪,这直接影响到阅读体验,像我这种爆脾气,要不是因为穷,直接就把手机摔地上了。

有趣

要让文章变得有趣起来,可读性强。

  • 发挥出全身上下的幽默细菌,适当写些段子无伤大雅,甚至可以加入一些故事情节,让人回味无穷。
  • 专业名词少用,说话越土越好越容易让人理解。别整天扯那些名词,又不是在写论文。
  • 有图千万别写字,有表格用表格,一张图胜过千言万语,当然了,能用动图就更棒了!

当然,有趣是建立在精简的基础上,又不是在写童话书,突出重点,把握好火候。

成体系

我看到很多大神技术水平很强,但是喜欢站在自己的角度上说技术,别人基本没办法看懂,写出来的文章也只能自己看。

在这里我特别想说,当我们在看一篇文章或一本书的时候,看个几行心里面产生一种情绪,“啊,太难了,我好菜啊!” 这不是我们的错,而是写文章的人的问题。

写技术文章不是写流水帐,要有脉络,从易到难,循序渐进,针对一个新概念要想清楚表达的方式。拆分难的知识点成小块,最后再联系起来。让人一下子看懂,成就感满满!我比较喜欢问自己:

  • what ? 我要讲的点是个什么东西?
  • why? 这个东东能做点什么,有什么用?
  • how? 要怎么做才能用上(实现)

最后

编程三分钟从4月27号开始到现在已经有整整五个月了,谢谢大家对小熊(我)的支持,风里雨里,我在等你。加油!

image.png

推荐阅读
关注数
1
文章数
11
热爱折腾的程序员开发运维:Linux、go/c++/python、redis/mysql/mq等、算法、自动化等内容。云计算:openstack、k8s、ceph等内容。其他:HA、架构、工具、网络安全、持续集成等内容。
目录
极术微信服务号
关注极术微信号
实时接收点赞提醒和评论通知
安谋科技学堂公众号
关注安谋科技学堂
实时获取安谋科技及 Arm 教学资源
安谋科技招聘公众号
关注安谋科技招聘
实时获取安谋科技中国职位信息