撰写技术文章的注意事项

本文将简单介绍 技术文章的阅读体验 中的主要思想,为以后自己写文章打下良好的架构基础。评价一篇技术文章的标准是:让符合阅读条件的读者,在较好的阅读体验下,看懂学会甚至掌握文章想要传达的思想或技术。下面将要介绍的几种原则都是为这个目的为服务的。

用户定位

写文章是一种传递信息的方式,博客这种非对称的传递方式,让读者和写者之间存在信息不对称,为缓解这种因不对称而带来的阅读压力,文章需要在开头处,向读者介绍阅读后续内容所必须的基础知识。如果读者没有这些基础知识,在后续的阅读中可能会遇到理解上的障碍。而对于具备这些知识的读者来说,需要在文章的末尾,给出进一步深入学习的建议作为补充,以及列出在撰写本文的过程中所涉及到的一些参考资料。

善用章节条目

对于一些比较长的文章,要善于利用章节条目等逻辑结构来降低读者的阅读负担。在写文章开头时,除了需要提到基础知识外,还需要简要的概述下,读者在阅读完本文后,可以了解到什么知识或者技能。不管是讲解什么知识,知识本身和它讲解的方式,同样重要,从简单到复杂,从简单例子的解决逐渐过渡到复杂案例,一步步增加外部条件,一步步引入新的解决思路来解决问题,层级递进的进行知识的阐述,而整个过程中问题和解决方案的同步演化,可以用不同章节条目来分隔,让读者在进入到下一个阶段时,从阅读逻辑上有缓冲的时间。
在文章末尾,还需要再次重复一下文章的主要观点和内容,做到首尾呼应。

易读性的语言

教学相长,要想清楚明白地讲解一个问题以及解决方法,需要对该问题的产生背景和不同的解决方案有较好的理解,每种解决方案在特定场景下都是有价值的,这种理解体现在能不能用自己的语言来通俗易懂而又清晰明白的来阐述。我现在还深刻地记得,在大学期间看到的一个关于进程和线程的解释,它是这样说到的,进程就像是一架马车,而线程就像是一匹马,一架马车至少有一匹马才能跑起来,不同马车上载的货物各不相同,马与马之间,马车与马车之间,都是可以相互沟通的。具体出处已经不记得了,我当时看到这个类比时,真是大为震惊,操作系统理论概念居然能和现实生活中的事物有如此巧妙的联系,只有既深刻理解进程/线程关系,又热爱生活,善于思考的人,才能想出如此精妙的类比,这真真是通俗易懂的语言。

字不如表,表不如图

在内容表现力上,文字不如表格,而表格不如图形。这三者在表现力上各有各的侧重点,需要根据不同的场景需要来选取使用。

及时回复评论

当你看到有读者给你留言时,悬而未决/置之不理都不是作为一个专业人士的态度,不管能不能解决他的问题,都要进行有礼貌的回复,能解决的,给出解决建议,不在自己能力范围内的,也要给出可能的搜索方向,这是对他人的尊敬。

posted @ 2018-05-06 20:58  浩天之家  阅读(422)  评论(0编辑  收藏  举报