微信号:infoqchina

介绍:有内容的技术社区媒体

400页,2天教你写出完美的技术博客

2018-11-30 09:22 InfoQ

某天闲来无事打开拉勾,看了看程序员的招聘文案,发现了一个神奇的现象:




很多程序员的工作要求上都开始要求写作能力了。


粗看觉得八竿子打不着,后来仔细想想,也在情理之中。


拥抱开源、热爱分享可以说是程序员的一个职业病,甚至很多互联网公司的技术团队还会有一个专属的技术博客或者公众号,以便定期在上面发布技术文章,比如阿里巴巴、美团、淘宝等。所以也无怪有些公司会注重应聘者的技术博客了,它可以让公司快速地评判一个人的技术水平和学习能力。


这也就是说,身为程序员,在这个四通八达的网络世界里,写作与你不再是毫无关系。


但很多程序员提起写作就头大,觉得这是一件特别考验文笔、特别细腻的事情,于是干脆敬而远之。



即便是对那些已经初步建立技术博客的人来说,有时也会有一种很尴尬的情况发生:自己辛辛苦苦写的文章,满心欢喜地发出去,期待一场火花四射的交流,结果评论一水儿的“看不懂”,满腔的冲动受到挫败,于是开始怀疑“是我的文笔不好吗?”。


什么样的文笔才算好文笔?


《射雕英雄传》里面,黄蓉要给洪七公做自己最拿手的菜,洪七公惊喜地问道是什么菜时,黄蓉回答的却是一些非常普通的家常菜:烧白菜、蒸豆腐、炖鸡蛋之类,全然不是先前的珍馐美味。但洪七公却内心了然——“真正的烹调高手,愈是在最平常的菜肴之中,愈能显出奇妙功夫,这道理与武学一般。”


放诸写作,亦是如此——能用简洁简单的文字讲清楚一件事情,就算得上是好文笔。


提起文笔好,很多人心中也许会闪过这样一个公式:辞藻华丽=文笔好。


很多程序员觉得自己不会写、不能写,恰恰是受了这种风气的伤害。总觉得不把文章写得华美绮丽,就不算厉害。但这种风格写起来实在头疼,久而久之,就觉得写作是一件苦差事,畏畏缩缩,不敢动笔。


其实这根本就不是问题,无需费神烧脑。对技术博客、技术文档而言,堆砌辞藻、故作高深就是原罪,因为它不是让作者来自嗨的,而是服务大众的。所以一篇好的技术文章首先要逻辑清晰,能让人读懂,其次语言简洁干练,不说废话。



我们用甄嬛体模拟一下程序员的日常:


“今儿个是上班第一天,忙着编码虽是要紧,却也不能忘了质量二字。如今的代码虽是越发得整洁了,但今日不比往昔,PD的需求必是应接不暇,催促得紧。若是没想好,出了错,人没事儿倒也罢了,便是耽误了项目的进度,这月误了发布,也是要挨罚的。”


“说人话。”


“我会好好干活的。”


如果现实中有人用甄嬛体说话或者写字,我们恨不得原地蓄力向上弹三米然后垂直落下借势打爆他的头。



说话的目的是为了交流,不是装X,这和写技术文章的目的其实是一样的。所以对很多程序员,尤其是那些需要写技术文章的程序员来说,词汇量、阅读量都不需要担心,真正要解决的问题是如何才能用简单明了的方式讲清楚一件事情

 

故作高深的文章连学术专家也讨厌


在美国有一个心理语言学家叫史蒂夫·平克,尽管贵为学术专家,但他和我们普通大众一样,对那种故作高深、装腔作势的写作方式感到不解,并且深恶痛绝:晦涩的文章乃是作者刻意的选择。……伪知识分子喋喋不休地用晦涩的冗词赘语来掩盖自己肚子里没货的事实。


作为技术人员,相信你一定看到过这样的文章,放眼望去全是专业的英语术语,通篇都是看不懂的晦涩概念。


读者看不懂,作者却在想你们为什么看不懂呢?



对于这种现象,史蒂夫·平克有趣地将它称之为“知识的诅咒”——作者根本想不出,你知道的事情在不了解这件事的读者看来是什么样子。


于是史蒂夫·平克写了一本书,叫做《风格感觉》,里面详细论述了写作中常见的坏毛病,并且用大量的例子进行佐证剖析,告诉我们文章要怎么写才能让读者看懂,真正做到对他们有用。


这本书的目的只有一个,那就是教会读者摒弃高深复杂的词汇,用简单干练的语言写文章。


这恰恰是程序员所需要的。


作者提倡的这种写作风格也是非常适用于写技术文章的。


更重要的是,它一点也不难。作者通过这本书打破了我们对写作的恐惧,让我们知道写作是一件很自然的事情,就像说与看那样简单。 


所教的方法论具有实操性,不假大空


作为一本写作指导书,里面没有从宏观角度上提“你应该去多读书啦”“多积累词汇”这种假大空的建议,而是在语言的修改范围内给出了具体可执行的建议,告诉我们只要巧妙地运用文字之间的成分关系,就可以让文章变得简单易读。


1、 不用元话语和语标


你一定看到过这样的句子:“本章就Java死循环的问题展开讨论。”里面的“本文就”“讨论”其实就是元话语和语标。如果通篇都是这样的词语,那么读起来肯定会兴趣寥寥。


这句话完全可以改成“如何解决Java死循环呢?”


2、  不用专家腔


同样针对少儿编程火爆的问题,专家腔式的文章可能是这样的:“近年来,越多越多的教育专家将注意力转向儿童编程的流行问题。本文将评述这一过程近年来的研究。”


想看吗?


反正我是不想看。


人们不想关心教育专家怎么样,而是儿童编程怎样。如果按照作者的方法改成这样,就会好读许多:“儿童编程越来越火,是什么造成了这一现象?”


3、  语言清晰,避免模糊


很多作者写技术文章的时候会大量使用“几乎”“显然”“近乎”“大概”这类的词,好像觉得这是一个“责任免除声明”——如果讲得有错,那可不怪我啊。


实际上呢?这会严重影响这篇文章的可信度,作者也会遭到质疑。所以如果不确定对不对,那么最好的方式就是不要写。


4、  使用主动语态


其实这个很好理解,人类的大脑更愿意接受正面的消息。举个例子,“买黑色笔”和“不要买红色笔”中,你觉得哪个更容易记住?肯定是前者。因此写作的时候,请尽可能地给出正面的建议。

 

所以你看,上述几点建议对技术类的文章来说都非常实用,这还只是一小部分。除此之外,作者还立足于文章本身,告诉我们如何把文章写得连贯通顺


看见纷繁复杂的技术资料不知道该怎么整理?

即便处理好了也不知道要如何确定立意?

那些反复出现的专有名词该怎么称呼才不显得啰嗦呢?

……


所有这些你有可能遇到的问题,作者都帮你设想好了,并且用了大量实例告诉你该如何解决。


举例丰富,表格展示清晰明了


相信很多人的语文老师都布置过“摘抄好词好句好段”这个作业,有的老师甚至还会将之纳为常规作业,时不时地还要来一次抽查。

 

为什么老师们如此重视这个作业?


《风格感觉》这本书里,作者给出了答案:“先成为好读者是成为好作者的起点。”


所以在书中,作者并没有一开始就教我们如何写作,而是引用了相当丰富的文章和句子,一一进行剖析,告诉我们这些文章或句子都好在哪,但也不用担心,这种剖析并不像语文阅读理解一样变态,而是站在了读者的角度上,充满了“没错啊,这样才是说人话的”的感同身受。


比如很多技术文章不免会涉及到很抽象的话语,如何才能把抽象的概念解释得通俗易懂呢?


作者举了一篇天文学家写的关于“多重宇宙理论”的文章,并且用普通大众的身份做了解析。



而对于如何避免写作的误区,作者也用表格的形式给出了相当丰富的例子,基本上每一条建议都有一到两个例子作对比。


这里举几个例子。



所以这本书有着非常强的实用价值,如果你是一个对写作头疼的程序员,那么你需要这本书作为一本专业的写作指南,以此来指导你更好地进行写作。


如果你有一个初步建立博客的打算,那么就让这本书帮你完成第一篇技术博文吧!


本文只能体现这本书内容的冰山一角,如果你还想看到更多有用有干货的建议,欢迎点击下方图片进行购买,现在购买还可以享受今日限时优惠哦。


有关程序员的一切,统统都在“阅读原文”里,少侠,不点开看看?


 
InfoQ 更多文章 从“被动挖光缆”到“主动剪网线”,蚂蚁金服异地多活的微服务体系 分布式系统中最容易被忽视的六大“暗流” 移动互联网的下半场,Android开发者在焦虑什么? 代码行数、查杀bug数笑笑就好,技术团队的KPI到底怎么定? 放弃Python,Uber用Go重写Schemaless数据库的分片层
猜您喜欢 马云的技术合伙人,人家牛逼是种习惯 技术贴:嫁给程序猿好吗? Etsy如何及为什么要迁移到API优先的架构 【深入浅出容器云】五分钟带你玩转Docker容器服务 SHELL编程之内建命令