- 技术写作手册
- ThoughtWorks中国
- 4字
- 2022-05-07 15:55:56
长期主义
李一鸣:《这几年技术写作的感悟》
从翻译开始
大概在4年前,我开始技术写作。当时在学习Shiro,顺手翻译了几篇官方文档。我觉得这几篇文档写的很不错,但是英文不好的同学阅读起来会比较费劲。另外,翻译的过程也比较费时。既然我已经翻译过,为何不分享出来?于是便注册了博客,发布了三篇Apache Shiro的官方文档翻译。
再次登录博客,时间已是半年之后。发现其中一篇有7000多的阅读量,这个阅读量还是挺出乎我的意料。不过其他两篇阅读量只有几百。为什么有一篇阅读量这么高?当时的我没想明白。很久之后才发现可能是因为这篇文章在百度检索靠前的原因。在百度中搜索“Apache Shiro文档”,可以看到三年前的这篇翻译排在最前面。
7000多阅读量也给了我写作的信心,于是写博客的念头也就延续了下来。
开始原创
一年后,由于工作上需要使用Apache Kafka,于是花了些时间学习。后来在团队内做了一次分享。在这个过程中,我阅读了很多文档和书籍,逐一消化成为自己的知识。如果把自己学习到的内容以系列文章的形式留存下来,不仅让自己能够学习的更深入、记忆的更牢固,而且也能够帮助到初学者。其实之前我没写过技术博客,更没写过教程,没有任何经验。但我对于自己把一个问题说清楚的能力比较自信,另外也相信自己能坚持下来。于是一上来我就定位写系列教程文章。
我对于文章的要求是通俗易懂。所以多采用生活中的例子以及绘制了大量的图表用于文章中。彻底理解了的内容我才会写上来,并且一定力求读者能够看明白。在之前学习过一遍的基础上,大概又花了一个月的时间完成《Apache Kafka入门教程轻松学》系列8篇博客。
接下来我又完成了《ZooKeeper入门实战教程》系列,一共5篇。后面写了一些Apache pulsar的翻译文章及其他一些零散的文章。
有何回响?
写完博客当然希望有更多的人来看。但是如果一开始就报这个目的去写,一定是急功近利。为了点击量有一万种写法。为了博客的关注量,也可以有一万种写法和做法。但这对文章质量可能毫无帮助。其实投机取巧的方法有很多,不过我不想走这种捷径。
我最初的想法很简单,踏踏实实写一些对自己和读者真正有帮助的文章。不浪费读者的时间,也不浪费自己的时间。最开始就坚定以内容质量为核心价值来写文章。
博客一开始自然没有什么点击量,不过也并不影响写博客的心情。不过偶尔有人留言问问题或者给我鼓励,我还是很欣慰。写作目的不一样,写作的心情就不一样,最终写出来的内容也不会一样。管那么多呢,先把心思花在文章质量上。
一次和同事聊天,他说那天我在百度搜索Pulsar,第一个结果就是你的博客。当时我很诧异,因为之前从没有把我的博客和百度联系起来。当时Pulsar确实属于比较新的工具,文章比较少。我也只是随便写了一篇介绍文章而已,毫无质量可言。但是这篇文章的访问量却比用心写的那些博客高的多,也不知道该高兴还是难过。不过通过这个事情,我了解到百度的力量。怪不得那么多公司不惜重金在百度上做SEM或者SEO。
当时我觉得这只是因为Pulsar比较新,我钻了个空子被百度排在了前面。因为文章本身没什么价值。所以其实并没有给我带来什么成就感。
有段时间我换了新的工作后,工作比较忙,没时间继续写博客。后来又有段时间去别的平台写专栏。但这段时间博客的关注量、评论量、点赞量一直是上升的趋势。因为有之前Pulsar的事情,我想到是不是有哪篇文章在百度排到前面去了。于是去百度搜索了下,发现按照技术名称+教程或者+标题中关键字检索,我的一些博客排在了前面,比如按照“apache kafka概念”、“apache kafka教程”、“apache kafka入门”、“zookeeper教程”、“zookeeper入门”等相似关键词搜索,我的博客都能排在前三名。
这次和Pulsar文章排在前面比较起来,感觉是不一样的。因为这些文章确实是我花费心思去创作的。自己的文章能被更多人看到,能帮助到更多初学者,还是很有成就感。最重要的是坚定了继续写下去的信心和动力。
一些感想
我开始技术写作到现在已经四年多,时间不算太长,不过也有些个人有些感悟。随便说一说。
写作目的
首先想说的是写作的目的。写博客没有利,说俗点就是赚不到钱。那么写博客会出名吗?不排除有些大牛会通过博客出名。但是对于绝大多数写博客的人来说是不会出名的。读者看到你的文章能解决他的问题,并且心情好时,可能会给你点个赞。但谁也不知道你是谁,而且技术博客这么少的阅读量也不足以让你出名。但是技术博客是一个窗口,能让更多人能看到你、了解你。如果你的文章质量足够好,当然也会有更多的机会找上门,比如说写专栏、甚至出书。不过这些毕竟是少数,刚开始技术写作的朋友还是应该脚踏实地,写好每一篇文章,并且坚持下来。
从我个人而言,我写博客出于以下几个目的:
巩固学过的知识
分享知识,帮助更多同行
成就感
最开始我只是想通过文章巩固自己所学知识。学习是输入的过程,写文章是一个输出的过程。如果能在工作中实践当然是最好的输出,但并不是学习的内容都有实践的机会。那么写文章输出也是个不错的选择。
如果写文章只是为了巩固知识自己看,那么文章的质量就没那么重要,自己看懂就好了。当你的文章将要对外发布,需要考虑的因素就会更多。比如是不是通俗易懂,有没有模糊的知识点、有没有错误、语句是否通顺等。
如果想让更多的人看到你的文章,文章的质量就变得尤其重要。技术领域一切都以质量说话,时间沉淀下来的肯定是有质量的文章。比如我之前在百度排在前面的Pulsar的文章现如今已经在几页开外了。
成就感对于我来说是个副产品,是随着你的写作而来的。但是很重要,因为这是正向的反馈。有人在读,说明你写的还可以,并且确实也帮助到了一些读者。那么继续写下去才有更大价值。
在这个自媒体泛滥的时代,好多文章选择标题党或者走其他走捷径的方式。但在技术领域行不通。不要一开始就冲着文章的点击量去写文章。其实你只需要搞定一件事,那就是文章的质量。其他都是随之而来的。当然好的标题也很重要,不过再好的标题也要有同等质量的文章相匹配。
长期主义和积累
写博客是个积累的过程,从你的第一篇博客开始,到10篇、100篇,以至更多。这绝对是一个长期的过程。当然也有办法让你的博客一天就刷到100篇,比如转载。但是这样做没有价值和意义。我也不清楚我的博客在百度中排到前面用了多久,但我相信肯定不是三个月就能做到的。
文章开始没有点击量很正常,不用气馁。至少从我的经验来看,只要文章写的不错,终归会被读者认可。
还记得最初写了几篇博客后,没有人关注,阅读量也很低,难免心里会有些失落。但是随着你积累的文章越来越多,你会发现各种数据都会加速上涨。因为写文章是一次付出,持续收获。每一篇文章都是你的存款。即使有段时间你不写博客,还是会新增很多关注、点赞。当然,写作是一种习惯,需要坚持,最好不要中断。
写博客的快乐和痛苦
写博客很快乐,否则也不会写下去。学到知识的快乐、分享的快乐、被认可的快乐。然而痛苦也会很多,要写出一篇质量比较好的博客,需要付出很多。首先自己要彻底搞懂要写的技术,然后再用自己的语言通俗易懂的写出来,还要自己绘制图表。这个过程需要付出很多时间和精力。
以我的经验,一篇2000-3000字的博客至少需要4个小时左右(学和写)。要求更高的专栏文章,起码要6个小时。只是写写博客还好,毕竟没有交稿的压力。如果和平台合作写专栏,面对交稿的时间点,会给你巨大的压力。我曾经写了半年专栏,业余时间除了写就是写。每晚几乎都是1点以后睡。周末要带小孩,于是抓各种空子写。小说、电影、电视剧基本和我告别了。
有人认可你的文章,自然也会有人认为你的文章是垃圾。不要因为个别负面声音影响自己的信心。自己的文章当然也会有错误。读者指出来,最初会觉得有点没面子。是人就会犯错嘛,既然放到互联网上,就不要怕犯错。其实读者也是在帮助你纠正错误的知识点,是个好事情。
说了这么多写作的痛苦,但写博客的好处会更多。比如下面这些:
能力锻炼
写博客是吸收知识、消化知识、再次形成知识的过程。在这个过程中,你的学习能力、总结能力、表述能力都能得到提升。
巩固学习的知识
博客也可以认为是你的学习笔记。通过写博客可以巩固学习到的知识。在你工作中或者面试前,可以用博客来复习。
个人能力背书
短短几十分钟的面试,根本无法让面试官对你有全面的认知。如果你的简历中有博客地址,面试者可以通过阅读你的博客,对你有更全面的认知。这是我在面试过程中的切身感受,很多面试官都会去看你的博客。
此外,博客也是你对外展示的窗口,更多的人可以通过博客认识你。通过写博客,我才有了和专栏平台合作的机会。这是我最初写博客没有想到的。最初专栏平台通过博客找到我写专栏,我还有些犹豫,不知道自己能不能写出来并坚持下去。后来想给自己一个挑战,于是就把这个事情接下来了。过程是相当痛苦的,这里就不再详述,不过总归是完成了专栏。写专栏的过程对我后来工作上碰到的一些困难还是很有帮助——只要有信心,朝着正确的方向坚持前进,那么一定会胜利抵达终点。
最后
这几年写技术博客的快乐肯定大于痛苦。而且之前所谓的痛苦,现在看来也不算什么。以后肯定还会坚持写下去。学习是长期的事情。学习之余,把学到的知识总结成博客,对自己有益,又能帮助到其他有需要的人,哪怕只是一小部分,那又何妨?学无止境,笔不停耕。