前言
可能作为程序开发人员会遇到很多读技术文章的机会,但是经常遇到文章读一遍下来会遇到各种问题。
首先是读下来不感兴趣
,都不知道文章要说些什么;或者 读不动
,通篇讲的都跟教科书的内容有得一拼,或者是文章太难了,读不懂
,文章内容太晦涩,读起来跟读天书一样;又或者读起来读不通,这里懂一点,我看下,那里读不通
,我跳过,最后下来能吸收的就一点点,又或者是其他的问题,这里就不列举太多。所幸自己也读到了不少好的作者写的文章,觉得他们写的文章让人学习起来就比较舒服、自然,而关于他们写作的时候的特点,如何阐述一个技术问题、然后分享技术知识的,有很多不错的特点可以学习起来。
下面是我的一些总结,可以给同行一起讨论下是不是这样的文章才是你想看的文章, 也为以后自己写出更好的博文,做一个方法论的探讨跟指导。
要求
- 0、前言,围绕的背景,解决的是一个什么样的,开发场景中可能遇到的问题,一开篇上来就开始丢技术描述,我很难往下看,也不知道是不是我要读的。
- 1、列举本文所涉及的关键字,以及关键字的解释,避免读者遇到的时候产生畏难心态,读一半然后读不下去。
- 2、文章要有架构,总分总,还是总分,还是抛出问题,然后围绕问题展开收集,分析,假设,论证,总结。
- 3、文章讲解的时候要通俗,不然用流水式,贴引用的文字、百科内容,(所谓的不讲人话),别说别人,自己都看不懂,要有例子、结合能够让人理解的最简单知识层面,阐述出来的例子,经过自己思考的描述之后,然后再加工出来能让人更好的理解。
- 4、文章要有实用性,你贴了个方案,代码没有,那疑问还是在那呀,怎么用代码实现,是不是连你都不知道,你可以贴核心的关键代码,点到即止,可以阐述到解决自己的问题就行。
- 5、对比,你的方案,你的问题跟别人不一样的地方,好在哪?优化在哪?哪里不一样了?你能怎么说服别人。
- 6、文章要有图片,有到位的图片解释,可以有锦上添花的效果。增加文章的多样性。
- 7、总结。‘结案陈词’ ,写完之后来一个总结,用一个脉络穿起前面讲的知识点。不然一篇下来,自己跟读者都不知道讲了啥,让彼此来复述一遍,可能都讲不出来。如果用图更加形象,可以是用一个思维导图,我见过好的文章里面会有一个用思维导图的总结,起到的总结作用比文字来得更好。
总结
0、前言背景介绍,
1、引导读者,
2、列举可能遇到关键字及解释,
3、结合自己认知通俗性阐述,
4、内容要有实用性,
5、技术的对比,
6、内容多样性,
7、内容的总结。
说实话,感觉自己要写出来这样的文章都会觉得难,但是当从一个读者的角度来想自己的文章是不是可以让人读懂接受,是一个比较好的侧面来要求提高自己的博文水平跟质量吧。