对程序员来说,技术文章的写作是比较重要的事情,不管是在公司内的总结汇报,还是想增加社区的影响力,都离不开写作能力。
之前总结过一篇写技术文章的心得,叫做《技术文章的核心是什么?谈谈我的思考》,主要讲了技术文章的核心是逻辑清晰。
距离那篇文章有一段时间了,我又踩过一些坑,有了一些新的感悟:
技术文章要在逻辑清晰的基础上,进一步追求文章的易读性和实用性,提升阅读体验(也就是阅读时的爽感),增强文章的吸引力和价值。
而要提升技术文章的阅读爽感,要考虑这么几点:
环环相扣
如果说做到逻辑清晰是技术文章的基础,那环环相扣就是技术文章的进阶了。
环环相扣是指内容不要一下子全讲完,要留下一个信息缺口,引出下一部分内容,直到文章最后再完整闭环。
从标题开始就要留信息缺口,引起好奇心,吸引读者继续往下读,这样完读率会比较高。完读率高了,其他数据才会好。
这方面举一个反面的例子:
这篇是讲 Nest.js 如何做参数验证,并且通过这个案例介绍 Pipe、ExceptionFilter 这两个 Nest.js 的功能。
其实内容还行,有这两个机制的介绍、也有跑通的案例,但数据相较其他文章并不是很好。
后来我思考了一下原因,发现了两个问题:
- 标题直接给闭环了,没有留下信息缺口:
直接在标题里面列出了全部的内容,虽然对文章内容是一个总结,但是没有留下信息缺口,会让人没有点击的欲望。如果换成《Nest.js 做参数验证的两个底层机制》,应该会更好一点。
- 第一段的内容也是,直接列了会用到哪些技术,给闭环了:
其实列出要讲的点没啥必要,因为这时候列出来读者也不知道它是啥,反而因为知道了后面会讲啥,会失去一些对后面内容的期待。
应该是引出“后端的参数验证”这个话题、激发读者的好奇心就可以了,然后后续内容一点点讲清楚 Nest.js 如何做参数验证。在文章最后闭环,做个完整的总结。
能够做到环环相扣的技术文章是更有吸引力的,因为阅读的过程是满足读者好奇心的过程,体验也会更爽。
交互性
阅读技术文章其实是读者和作者的一个双向的交流,作者讲了一些东西,会引起读者的思考或情绪,之后读者会基于这些思考或情绪继续往下读。
如果在适当的地方抛出一个问题,或者放一个合适的表情包之类的,会有更轻的互动感,阅读体验会更好。
但是,互动不要太多,适当点缀即可,能把内容从逻辑上讲清楚是最重要的。
删繁就简
在保证内容完整性的基础上,内容越简炼越好。
能更简洁明确的表达你的意思,读者阅读起来就会更省力,体验也会更好。没有人喜欢啰里八嗦半天讲不到重点的文章。
标出重点
一篇文章肯定有想重点表达的内容,把它加粗高亮。
作者肯定是更清楚文章的重点是什么,直接标出来,不需要让读者自己去思考总结,这样阅读起来会更省力。而且喜欢速读的读者,也可以快速 get 到文章想表达的内容,满足这部分读者的需求。
实用性
学习技术肯定是为了用,所以技术文章的案例要尽量更有实用价值,而且最好提供完整可跑通的代码。
我前面很多文章都提供了可跑通的案例,并且把代码传到了 github 或完整贴在了文章里。这样读者在理清思路之后,想尝试一下的话,可以直接把代码下下来跑跑。
我写小册和文章都是这样做的:
通过文章读懂思路并不是最终目的,能进一步用起来才是,这样文章的价值会更大一些。
标题要激发好奇心
关于起标题,其实我做的并不好,所以我阅读量忽高忽低的:
这方面我也在学习中 😭。
我最近看了一些新媒体写作的内容,提到了一个点:
起标题要能激发读者的好奇心,最好能生理性的想读,就是不经过思考,下意识的就想看。
当然,这并不是说要标题党,只是改变下起标题的方式,提炼一些读者会感兴趣的点放到标题里,增加文章的吸引力。
其实我去年阅读量最高的一篇文章的标题起的就还可以:
既点明了文章讲的是什么,又能激发读者的好奇心。
总结
技术文章首先要做到逻辑清晰,这是最最基础的,但是要出彩,还要做到更多:
- 环环相扣:每一部分内容要留下一个信息缺口,吸引读者继续往下读,到文章最后再闭环。提升完读率是其他数据的基础。
- 删繁就简:在完整表达内容的基础上,语言越简练越好,这样文章读起来会更省力。
- 实用性:学习技术是以用为目的,文章的案例要尽量更实用一些,并且要提供完整可跑通的代码。
- 标出重点:标出想重点表达的内容,让读者能轻易 get 到文章的核心。
- 交互性:读者阅读文章,是和作者的双向交流,适当增加一些情绪上或思考上的交互,会增加读者的阅读体验。
- 标题要激发好奇心:标题最好能让读者生理性的想读,所以要提炼文章中的比较有意思的有价值的点作为标题。标题是文章的开始,重要性是很高的。
这些是我写过大量技术文章之后的总结:技术文章要在逻辑清晰的基础上不断的追求易读性、实用性,增加文章的吸引力和读者阅读体验,让文章读起来爽感更强,传达更多的价值。