作为一个技术人,写文档可以说是工作中的一部分。除了文档之外,我们还会学习新的技术、总结工作经验,从而沉淀出自己的知识体系。我们经常说:[好记性不如烂笔头],只有把这些凌乱的,无形的知识加以梳理,我们才能够更加深刻地去理解、去构建自己的知识库。其实,这些都是知识管理的范畴,将无形的知识显性化,一方面可以加深自己的理解和记忆,另一方面也方便知识的分享与传播。所以,善于总结并输出技术文章是一个很好的提升的自己方式。

很多的人会很好奇,怎样才能写出一篇高质量的文章呢?下面我们就聊聊写技术文章的方法和技巧,包括文章的框架、思路、撰写的套路、模板等等,希望本文对你有所帮助。

写文章之前需要思考的三个问题

写给谁

当我们还没有写技术文章的习惯或者经验时,大部分人会把技术文章写成一篇总结笔记,仅仅是罗列一些知识点而已。这对于刚写技术文章的人来说,是一个必经之路,只有先写出来,后面才有进一步优化的可能。当我们有了一定的积累和经验时,就需要思考一个问题:写给谁,换句话说就是阅读的对象是谁。其实,写文章就像讲故事,我们只有明确了接收对象是谁,才能把合适的故事讲给合适的人听。

所以当我们在写一篇技术文章之前,不妨先想一想这个问题:我们为什么要写这篇文章?写给谁?希望阅读这篇文章的人得到什么信息?有什么结论?相信能够思考清楚这些问题,我们就明确的基本的文章大纲了。

2W1H

首先先解释一下什么是2W1H,所谓的2W1H,即是指:What、Why、How,这三个词可以把技术文章大致分为三大类。其一是What类型的文章,What很简单,就是解释概念,比如学习笔记就是这个层面的文章,比如你写一篇文章是介绍什么是数据仓库的,那只需要把数据仓库的基本概念、发展历程、以及一些架构和建模方法论写清楚就足够了。其二是Why类型的文章,相对于What类型的文章而言,Why类型的文章就会稍难一些,还是以数仓为例,比如写一篇为什么建数仓的文章,既要讲清楚数仓是什么,又要讲清楚为什么建数仓。最后是How类型的文章,可以说是比较高层次的文章了,比如要写一篇如何构建数仓的文章,这就需要给出方案,究竟该如何做

写作之前,要想清楚自己在哪一层,是希望给出What、还是进一步思考给出Why,还是想让读者获取How。值得注意的是,这三者不是割裂的,比如你要写一篇How类型的文章,What和Why同样是非常重要的,一般而言限于篇幅,我们不可能都面面俱到地呈现出所有,要有基本的取舍,不要贪多,最重要的是把事情讲清楚,还能让读者有所收获。

布局

上面两个问题主要体现两个字:谋篇,当我们想清楚写什么之后,就需要思考下一个问题:布局。所谓布局,即是对文章整体结构做出的规划安排。好的文章,通常是内容主线和逻辑脉络非常清晰的,要让读者有种醍醐灌顶的感觉,而不是仅仅满足自己的表达欲。比如要写一篇构建数仓的方案,那就需要定义清楚是解决了什么问题,有没有其他的方案,与其他的方案有哪些区别,对于其他公司有哪些可以借鉴的。如果一篇文章所介绍的方案或者技术的可借鉴性和可复用性很强,那么这篇文章的价值和受欢迎程度也是非常可观的。

行文过程中的奇技淫巧

标题

从传播学的角度而言,好的标题是文章很重要的组成部分。当然,我所说的标题是名副其实的标题,而不是所谓的为了吸引眼球的标题党。这里之所以把标题拎出来,是因为标题确实非常重要。虽然,酒香不怕巷子深,但一篇好的文章,如果没有一个好标题进行辅助,那么也很难让更多的受众阅读到。

那么,该如何取一个好的标题呢?这里是有一定的原则的,我这里总结了三个。其一是数字,比如金额、要点、排名、年份等等,这些数字很直观,很容易让读者感觉到文章的信息含量比较有价值。其二是用户体感,就是用通俗易懂的语言体现出文章的价值和结论,就像白居易写诗一样,做到老妪能解。最后一点就是神秘感,也即是能够引起读者的好奇心和阅读兴趣。

最后,需要重申的是,标题一定要与文章相匹配,切不可夸大其词,背离了写文章的初衷。

与读者建立连接

这一点通俗来讲就是要拉近与读者的距离,比如介绍一下自己的工作背景以及在哪方面具有丰富的经验等等,这些都能够提升读者对文章的认可度,当建立了这种连接之后,当读者阅读文章的时候,自然而然的会觉得文章具有说服力。

清晰的目录结构

清晰的目录结构就像路标一样,可以一步一步地引导读者去阅读文章。有的时候,我们的文章会很长,这个时候就需要先总后分,就是大致介绍一下文章的脉络结构和关键点,从而让读者有个初步的印象和判断,这样读者才不至于阅读完文章的开头部分之后就放弃阅读后面的内容了。

总结结论

一般文章的结尾把文章的要点进行一一列举,言简意赅即可,从而强化本篇文章的价值点和希望读者获得的东西,这样和文章的脉络结构进行相辅相成,读者可以在很短的时间内get到文章的核心内容,帮助读者把握住文章的价值。

排版

一般使用markdown的较多,比如可以使用无序列表、段落引用、粗体、斜体、代码标记等等。

图文并茂

图是表达信息的一个很重要的方式,有时候一张图可以很明白地把一个技术讲清楚,另外,图可以瞬间吸引读者的注意力,所以图片的信息价值是远超文字表达的。其实画图也是结构化思维和表达的一种训练方式。

总结

技术类的文章需要有扎实的技术经验积累和深度的思考,当你写技术文章的时候,也会倒逼你去学习整理、思考这些东西,所以会起到一个正向的促进作用。上文列举了写文章谋篇布局的一些技巧,当然,这些只是写好文章的必要不充分条件。其实一篇好的文章需要注意的点有很多,关键的点是多写多练,文章写得多了,自然而然会沉淀出自己的一套方法论,正如卖油翁的故事,无他,但手熟尔。值的注意的是,技巧的东西永远是锦上添花,切不可本末倒置。

公众号【大数据技术与数仓】,关注领取资料