写了近120篇博文的特赞CTO黄勇:技术写作也可以锦上添花

记得2013年9月1日,我开始在“开源中国”上发表博客,两年内我写了很多文章,同时也做了自己创立的开源项目,还认识了很多志同道合的朋友,最后也给自己带来了前所未有的机遇。

说句题外话:无论是“开源中国”、“简书”、微信公号,还是其他平台,只要我们敢于去写,并且坚持下来,就会发现平台只是形式载体,自我沉淀、知识碰撞才是最终的王。

-01-

起源

其实我在写第一篇博客之前,很纠结:到底要不要写?自己能不能写好?如果写得不好,会不会被人“喷”?

总之,都是一些负面的情绪,让自己没有勇气动手去做这件事情。

而我就是在一个很不恰当的时机写了我的第一篇文章。记得那是一个周末下午,老婆在客厅里发飙,小孩在床上哭泣,莫名地心力憔悴。我坐在卧室里对着“开源中国”网站首页发呆,然后点击了“写博客”按钮,于是轻描淡写地完成了以下这篇短文:Smart Framework:轻量级 Java Web 框架(可上“开源中国”查阅)

从此,自己的技术写作之路就根本停不下来。

坦率地说,当时写这篇文章时,我心里是没底的。因为文章中所描述的这是一款开源技术框架,我只是对此框架提了几点需求而已,当时根本就没有一行代码,怎么能叫“开源项目”呢?

我告诉身边的朋友:开源并非只是源代码的开放,而是思想的开放。

因此,我首先开放了自己的思想,然后才开放了自己的代码。具体过程是这样的,首先通过思想去和大家交换意见,然后得出合理的结论,最后产生具体的代码,再次循环迭代下去。我理解的开源就是这样的,它的本质其实是一个很有趣的社交活动,它的价值远远大于它的产出。

写这篇文章,只是想分享一些自己在技术写作上的成长经历与个人体会,希望本文可以给大家带来一点小小的帮助。

-02-

技术写作的价值

写技术文章实际上是对所学技术的再次理解与整理,通过文字的方式让自己的思路变得更加清晰。写技术文章需要不断积累,开头困难,后面轻松,而且积累到一定的量时,会产生质的飞跃,这一点我深有体会,相信写过技术文章的人也会有同感。

前几年我写了一些技术博文,几乎每周都写,最频繁可以做到“每日一博”。写技术文章不仅是对自己专业技能的提升,而且通过技术文章的分享与传播,还会带来很多“化学反应”,主要体现在以下几个方面:

1、让自己的文章能够帮助更多的人,产生更大的价值; 2、让自己认识更多的朋友,也能从他们身上学到很多东西,包括知识与技能,也包括做人做事的态度; 3、让自己被更多人关注,获得一生中难得的机会。

当初我就是通过写技术博客,被电子工业出版社“博文视点”编辑部的陈晓猛老师关注到,陈老师鼓励我写书,两年内出版了两本《架构探险》系列图书。

-03-

技术写作的技巧

写技术文章,首先要具备的能力是结构性思维。我刚开始写技术博客时,一开始并没去列大纲,写到哪算哪,最后发现篇幅很难控制,而且自己都觉得阅读起来不太舒服。后来我加以改正,在写具体内容之前,第一件事就是定义大纲,一级标题、二级标题,复杂情况可能还有三级标题。

定义大纲时是有技巧的,可以借助“思维导图”工具来完成,而且大纲标题需要做到言简意赅。第二件事就开始完善每个大纲中的内容,写文章类似于我们写程序,先要定接口(大纲),再写实现(内容)。

在写内容时也有技巧,比如:

1、要让读者感受到,阅读这篇文章就像是作者在和读者对话一样,文章中可以用“我” 或“我们”来表示作者,用“您”或“大家”表示读者; 2、要多用短句,避免长句,目的是让读者阅读起来更加舒服,如果感觉句子太长时,可以在合适的地方用逗号断句; 3、想让读者更有兴趣往下读,可以在正文开头编一个段子,但这个段子最好与文章有些关联性; 4、文中插图要绘制精细,一定不要随意,正所谓“一图胜千言”,图好,文也好,才是真的好; 5、文章结尾时一定要有总结,让读者读完文章后,能够快速抓到重点,产生一种“深入浅出”的感觉; 6、不管对自己所写文章是否有把握,都要在结尾处表明文章还有很多不足,希望得到大家批评与指正的话; 7、最后一件事情是为文章起一个吸引人的标题,一个好的标题会让文章获得更多的点击量和传播率,好文章往往就是内容好,而且标题也好。

技巧还有很多,自己动手写起来以后,就会产生很多经验。

如果担心自己无法坚持写下去,不妨给自己设置一个计划,比如多长时间可以写一篇文章。如果不知道自己应该写什么,不妨将自己从日常工作中所学到的技能做一个总结,当然也可以写自己的读书笔记或心得体会等。

总之,写作兴趣是可以训练出来的。

-04-

从写博客到写书

记得出版社老师鼓励我写书时,我也担心自己写不出来,毕竟一本书不像一篇博客,书的篇幅较大,前后还有一定的前后关联性,需要较强的内容组织能力,更需要坚强的毅力。

我在写第一本书时,一口气写了50多页,然后就写不下去了,因为觉得框架组织有问题。随后卷土重来,第二次写到100多页,仍然觉得不合理,再次放弃。直到第三次才一气呵成,写完了全书。花费了我将近半年的时间,才能写完一本书,可见周期较长,让人心力憔悴。

我在写第二本书时,总结了曾经犯下的错误,吸取了教训。一开始我就花了大量的时间做全书的大纲,通过三级标题来展现。第一章作为概述性内容,统领全书中心思想,随后的每一章,分别对第一章所涉及的内容,进行深度描述,每一章都是一个独立的板块,每一节都针对一个具体的问题。每章都按照统一的逻辑来组织,首先讲明白“是什么”,再讲“为什么”,最后讲“怎么做”。每章最后一节再来一个小结,汇总一下本章的要点,以及为下一章做一个铺垫。

按照以上方法,不仅让自己的写作思路更加清晰,而且也把写书当成一个项目来管理,这样自己也能更加有毅力地将全书写完。

最后的赠言:

不要吝啬自己在知识上的积累,更不要将知识据为己有,知识用出来才是珍宝,闷在肚子里那是废物。

作 者 介 绍

特赞CTO:黄勇

10年以上工作经验,现任特赞公司 CTO,曾任阿里巴巴公司系统架构师。具有丰富的互联网产品架构经验与技术管理经验,擅长敏捷开发模式,推崇“轻量级”系统架构。

国内开源软件推动者之一,活跃于 OSChina、CSDN、InfoQ 技术社区,Smart 开源框架创始人,畅销书《架构探险》作者,EGO 会员,QCon 讲师,StuQ 讲师。热爱技术交流,乐于分享自己的成长经验。

原文发布于微信公众号 - 养码场(yangmachang0)

原文发表时间:2017-06-08

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏数据的力量

数据分析那些事(菜鸟入门必看)

3795
来自专栏飞总聊IT

大数据那些事(36):后记

任何事物总有结束的时候。大数据这个系列到这里我就打算结束了。从最初开始写这个系列到现在也小半年了。时间之长远远超出了自己原来的预算。大约一个月之前的时候我开始考...

2968
来自专栏机器之心

业界 | Stack Overflow 2018开发者调研结果公布:DevOps和机器学习行业收入最高

选自Stack Overflow 机器之心编译 参与:路雪、黄小天、刘晓坤 近日,Stack Overflow 公布了其第八次年度开发者调查结果,这次参与者超过...

2866
来自专栏PPV课数据科学社区

【推荐】更多数据……巨多数据……大数据!

如果你所在的企业正在利用大数据支撑运营型分析工作,本章讲的正是这时你需要掌握和了解的那些关乎大数据的重要趋势。过去的许多年间,企业积累的数据越来越多。尤其是到了...

3016
来自专栏VRPinea

Oculus Connect 4:只有像Oculus这样的实干家才能在VR中活得如鱼得水

3257
来自专栏Java帮帮-微信公众号-技术文章全总结

【大牛经验】程序员3年之痒改变不止薪水

程序员3年之痒改变不止薪水 ? 程序员的3年之痒,的确是时候该挠挠自己了。3年的程序员生涯,不长不短,但它的确是一个坎。3年改变了我们的不仅仅是年...

3714
来自专栏PPV课数据科学社区

【经典好文】揭秘我所知道的网站分析

因为上一家雇主的缘故(国内Top2的专业数据分析公司),常会有很多电商的朋友来问我,到底网站分析(WebAnalysis,以下简称WA)是什么,有什么用,有没有...

3066
来自专栏腾讯大讲堂的专栏

“喂,你要不要让自己试试看?”

1223
来自专栏IMWeb前端团队

【IMWeb】前端圈外部分享沙龙精彩回顾!

本文作者:IMWeb link 原文出处:IMWeb社区 未经同意,禁止转载 ? 10月17号,IMWeb团队跟广州前端圈合作,在腾大二楼多功能厅,进...

2207
来自专栏程序员互动联盟

从学生到程序员

还未毕业就在百度实习了,两年多的磨练,有被磨平的棱角,也有精彩的收获;谨以此文献给在百度并肩奋战两年多的兄弟姐妹们。忘不了离职日那场特殊的告别午餐;忘不了这两年...

3245

扫码关注云+社区

领取腾讯云代金券