微信号:stuq2015

介绍:有干货,有情趣,随手拯救技术宅.

1024 | 10年技术经验作者黄勇分享技术人写作成长

2016-10-24 19:47 StuQ

最好的礼物是知识;

最好的同路人是因同样的目标兴趣走在一起。


1024程序员节,除了美好的祝愿礼物

还有不止步的分享学习——


一份围绕『 技术人写作成长』礼物清单:

  • 一位10年技术经验专家黄勇分享写作体验

  • 一个分享实践提升技术写作能力的持续行动计划

  • 一种获得专家赠书及StuQ1024🎁的方式


黄勇 | 10年技术经验专家

畅销书《架构探险》作者


分享专访Q/A实录


Q:程序员写技术文章与提升专业技能有没有相关性,原因是?


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

Q:是什么促使您坚持把写技术博客文章这件事一直坚持下去,从过程中获得的最大受益是什么?


A:前几年我写了一些技术博文,几乎每周都写,最频繁可以做到“每日一博”,而且只在“开源中国”上发表,在此特别感谢“开源中国”给我提供了这个平台。写技术文章不仅是对自己专业技能的提升,而且通过技术文章的分享与传播,还会带来很多“化学反应”。首先,让自己的文章能够帮助更多的人,产生更大的价值。其次,让自己认识更多的朋友,也能从他们身上学到很多东西,包括知识与技能,也包括做人做事的态度。最后,让自己被更多人关注,获得一生中难得的机会。当初我就是通过写技术博客,被电子工业出版社“博文视点”编辑部的陈晓猛老师关注到,陈老师鼓励我写书,两年内出版了两本《架构探险》系列图书。

Q:程序员写好技术文档/博客/文章,需要具备哪些技能和技巧,如何坚持,克服哪些困难?


A:我认为写技术文章,首先要具备的能力是结构性思维。我刚开始写技术博客时,一开始并没去列大纲,写到哪算哪,最后发现篇幅很难控制,而且自己都觉得阅读起来不太舒服。后来我加以改正,在写具体内容之前,第一件事就是定义大纲,一级标题、二级标题,复杂情况可能还有三级标题。定义大纲时是有技巧的,可以借助“思维导图”工具来完成,而且大纲标题需要做到言简意赅。第二件事就开始完善每个大纲中的内容,写文章类似于我们写程序,先要定接口(大纲),再写实现(内容)。在写内容时也有技巧,要让读者感受到,阅读这篇文章就像是作者在和读者对话一样,文章中可以用“我”或“我们”来表示作者,用“您”或“大家”表示读者。而且要多用短句,避免长句,目的是让读者阅读起来更加舒服,如果感觉句子太长时,可以在合适的地方用逗号断句。想让读者更有兴趣往下读,可以在正文开头编一个段子,但这个段子最好与文章有些关联性。文中插图要绘制精细,一定不要随意,正所谓“一图胜千言”,图好,文也好,才是真的好。文章结尾时一定要有总结,让读者读完文章后,能够快速抓到重点,产生一种“深入浅出”的感觉。不管对自己所写文章是否有把握,都要在结尾处表明文章还有很多不足,希望得到大家批评与指正的话。最后一件事情是为文章起一个吸引人的标题,一个好的标题会让文章获得更多的点击量和传播率,好文章往往就是内容好,而且标题也好。技巧还有很多,自己动手写起来以后,就会产生很多经验。如果担心自己无法坚持写下去,不妨给自己设置一个计划,比如多长时间可以写一篇文章。如果不知道自己应该写什么,不妨将自己从日常工作中所学到的技能做一个总结,当然也可以写自己的读书笔记或心得体会等。总之,写作兴趣是可以训练出来的。

Q:如何从程序员坚持写博客文章到了具备写书的能力,比如用定时定量的方法督促自己完成之类?有什么具体实践方法推荐?


A:记得出版社老师鼓励我写书时,我也担心自己写不出来,毕竟一本书不像一篇博客,书的篇幅较大,前后还有一定的前后关联性,需要较强的内容组织能力,更需要坚强的毅力。我在写第一本书时,一口气写了50多页,然后就写不下去了,因为觉得框架组织有问题。随后卷土重来,第二次写到100多页,仍然觉得不合理,再次放弃。直到第三次才一气呵成,写完了全书。花费了我将近半年的时间,才能写完一本书,可见周期较长,让人心力憔悴。我在写第二本书时,总结了曾经犯下的错误,吸取了教训。一开始我就花了大量的时间做全书的大纲,通过三级标题来展现。第一章作为概述性内容,统领全书中心思想,随后的每一章,分别对第一章所涉及的内容,进行深度描述,每一章都是一个独立的板块,每一节都针对一个具体的问题。每章都按照统一的逻辑来组织,首先讲明白“是什么”,再讲“为什么”,最后讲“怎么做”。每章最后一节再来一个小结,汇总一下本章的要点,以及为下一章做一个铺垫。按照以上方法,不仅让自己的写作思路更加清晰,而且也把写书当成一个项目来管理,这样自己也能更加有毅力地将全书写完。


专家分享的目的和意义,更多是让专家的分享直接指导实践,快速学习,彼此分享,共同成长。这个程序员节的礼物,就是一个可参考的方法论指导,加一个可实践的行动计划。


不做被动的知识获取者
『 技术人写作成长输出行动计划 』


『 技术人写作成长输出行动计划 』,目的即提升技术写作能力,养成技术写作记录习惯。行动计划以分享的学习方式分解为五个参与过程:


  1. 经验分享:邀请多位实战经验的技术专家讲师作者,组成「StuQ技术专家作者写作交流顾问小组」,每月一次一位来自小组专家讲师的分享——分享围绕多年坚持技术写作的经验、方法、心得、总结tips等;

  2. 专家问路:向「StuQ专家作者交流小组」任何一位专家作者投石问路的机会;

  3. 行动监督:根据自身实际情况制定合理时间计划,并保证完成,第一阶段需保证每月不少于两篇;

  4. 结果输出:一版专属的行动计划活动专刊,你的技术文章可能出现在专刊里;

  5. 交流评鉴:与一同参与活动的同行伙伴,专家作者阶段交流,共同见证成长。




1024纪念礼,加入行动计划小组,前5位以下两本书二选一


  1. 赠书一选:《轻量级微服务架构》,黄勇著

  2. 赠书二选:《途客圈创业记》,陈天著

  3. StuQ技术角色创意贴纸



    (长按二维码加入行动计划小组)

 
StuQ 更多文章 StuQ技能指导实录(三)_前端篇(内含音频) 一个完整的微服务系统,应该包含哪些功能? StuQ 课程预演|想快速掌握火爆的微服务架构技术?快来听老司机分享的学习建议 Hbase 源码剖析与实战——掌握阿里、小米、苏宁大数据工程师必备技能 | 即刻报名 StuQ课程预演丨跟西加加学习《搜索引擎架构实战》,从0到1构建⼀个完善的搜索引擎系统
猜您喜欢 【研发管理】互联网项目管理浅析之需求管理 数据解析:打球不用脑?威少就要这么疯! 【冬瓜哥手绘】并发IO—系统性能的根本! 【Qdata大会】Qunar​智能客服之工单分类 【Python爬虫实战】爬取糗事百科段子