记得2013年9月1日，我开始在“开源中国”上发表博客，两年内我写了很多文章，同时也做了自己创立的开源项目，还认识了很多志同道合的朋友，最后也给自己带来了前所未有的机遇。感谢开源中国，它给我提供了一个很好的平台，让我可以在这个平台上尽情地发挥自己的价值。
其实我在写第一篇博客之前，就在纠结到底要不要写？自己能不能写好？如果写得不好，会不会被人“喷”？总之，都是一些负面的情绪，让自己没有勇气动手去做这件事情。
记得那是一个周末下午，不知道为了什么，我和老婆怄气了，可能是因为小孩刚刚出生，每天哭哭啼啼的闹个不停，我们都被折磨的心力憔悴。老婆在客厅里发飙，小孩在床上哭泣，我坐在卧室里对着“开源中国”网站首页发呆。
不知道自己是受了什么刺激，点击了开源中国网站上的“写博客”按钮，于是轻描淡写地完成了以下这篇短文：
Smart Framework：轻量级 Java Web 框架
从此，自己的技术写作之路就根本停不下来。
坦率地说，当时写这篇文章时，我心里是没底的。因为文章中所描述的这是一款开源技术框架，我只是对此框架提了几点需求而已，当时根本就没有一行代码，怎么能叫“开源项目”呢？我告诉身边的朋友：
开源并非只是源代码的开放，而是思想的开放。
因此，我首先开放了自己的思想，然后才开放了自己的代码。具体过程是这样的，首先通过思想去和大家交换意见，然后得出合理的结论，最后产生具体的代码，再次循环迭代下去。我理解的开源就是这样的，它的本质其实是一个很有趣的社交活动，它的价值远远大于它的产出。
今天是10月24日，1024是程序员的数字，今天是程序员的节日。我想很有必要为开源中国上的程序员们，写点自己在技术写作上的成长经历与个人体会，希望本文可以给大家带来一点小小的帮助。
技术写作的价值
我认为写技术文章实际上是对所学技术的再次理解与整理，通过文字的方式让自己的思路变得更加清晰。写技术文章需要不断积累，开头困难，后面轻松，而且积累到一定的量时，会产生质的飞跃，这一点我深有体会，相信写过技术文章的人也会有同感。
前几年我写了一些技术博文，几乎每周都写，最频繁可以做到“每日一博”，而且只在“开源中国”上发表。写技术文章不仅是对自己专业技能的提升，而且通过技术文章的分享与传播，还会带来很多“化学反应”，主要体现在以下几个方面：
- 让自己的文章能够帮助更多的人，产生更大的价值。
- 让自己认识更多的朋友，也能从他们身上学到很多东西，包括知识与技能，也包括做人做事的态度。
- 让自己被更多人关注，获得一生中难得的机会。
当初我就是通过写技术博客，被电子工业出版社“博文视点”编辑部的陈晓猛老师关注到，陈老师鼓励我写书，两年内出版了两本《架构探险》系列图书。
技术写作的技巧
我认为写技术文章，首先要具备的能力是结构性思维。我刚开始写技术博客时，一开始并没去列大纲，写到哪算哪，最后发现篇幅很难控制，而且自己都觉得阅读起来不太舒服。后来我加以改正，在写具体内容之前，第一件事就是定义大纲，一级标题、二级标题，复杂情况可能还有三级标题。
定义大纲时是有技巧的，可以借助“思维导图”工具来完成，而且大纲标题需要做到言简意赅。第二件事就开始完善每个大纲中的内容，写文章类似于我们写程序，先要定接口（大纲），再写实现（内容）。
在写内容时也有技巧，比如：
- 要让读者感受到，阅读这篇文章就像是作者在和读者对话一样，文章中可以用“我”或“我们”来表示作者，用“您”或“大家”表示读者。
- 而且要多用短句，避免长句，目的是让读者阅读起来更加舒服，如果感觉句子太长时，可以在合适的地方用逗号断句。
- 想让读者更有兴趣往下读，可以在正文开头编一个段子，但这个段子最好与文章有些关联性。
- 文中插图要绘制精细，一定不要随意，正所谓“一图胜千言”，图好，文也好，才是真的好。
- 文章结尾时一定要有总结，让读者读完文章后，能够快速抓到重点，产生一种“深入浅出”的感觉。
- 不管对自己所写文章是否有把握，都要在结尾处表明文章还有很多不足，希望得到大家批评与指正的话。
最后一件事情是为文章起一个吸引人的标题，一个好的标题会让文章获得更多的点击量和传播率，好文章往往就是内容好，而且标题也好。技巧还有很多，自己动手写起来以后，就会产生很多经验。
如果担心自己无法坚持写下去，不妨给自己设置一个计划，比如多长时间可以写一篇文章。如果不知道自己应该写什么，不妨将自己从日常工作中所学到的技能做一个总结，当然也可以写自己的读书笔记或心得体会等。总之，写作兴趣是可以训练出来的。
从写博客到写书
记得出版社老师鼓励我写书时，我也担心自己写不出来，毕竟一本书不像一篇博客，书的篇幅较大，前后还有一定的前后关联性，需要较强的内容组织能力，更需要坚强的毅力。我在写第一本书时，一口气写了50多页，然后就写不下去了，因为觉得框架组织有问题。随后卷土重来，第二次写到100多页，仍然觉得不合理，再次放弃。直到第三次才一气呵成，写完了全书。花费了我将近半年的时间，才能写完一本书，可见周期较长，让人心力憔悴。
我在写第二本书时，总结了曾经犯下的错误，吸取了教训。一开始我就花了大量的时间做全书的大纲，通过三级标题来展现。第一章作为概述性内容，统领全书中心思想，随后的每一章，分别对第一章所涉及的内容，进行深度描述，每一章都是一个独立的板块，每一节都针对一个具体的问题。每章都按照统一的逻辑来组织，首先讲明白“是什么”，再讲“为什么”，最后讲“怎么做”。每章最后一节再来一个小结，汇总一下本章的要点，以及为下一章做一个铺垫。
按照以上方法，不仅让自己的写作思路更加清晰，而且也把写书当成一个项目来管理，这样自己也能更加有毅力地将全书写完。
最后的赠言
不要吝啬自己在知识上的积累，更不要将知识据为己有，知识用出来才是珍宝，闷在肚子里那是废物。
作者简介
黄勇，现任特赞科技 CTO，曾任阿里巴巴公司系统架构师。具有丰富的互联网软件架构经验与技术管理经验，擅长敏捷开发模式，推崇“轻量级”系统架构。国内开源软件推动者之一，活跃于国内知名技术社区，Smart 开源框架创始人，畅销书《架构探险》作者，技术大会讲师，企业内训师。热爱技术交流，乐于分享自己的成长经验。
特赞公司 www.tezign.com
特赞是一个具有创意基因的互联网技术团队，来自于人工智能、人机交互、大数据、SaaS 软件服务化、创意管理、广告媒体等跨学科背景的成员组成，毕业于哈佛大学、普林斯顿大学、哥伦比亚大学、复旦大学、浙江大学等国内外知名学府和 Facebook、阿里巴巴、新浪、盛大、豆瓣、奥美、Isobar 等著名公司工作经验。
架构探险图书微信公众号
414
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
