如何写出一篇高质量的技术分享文档
自己也写技术分享文章,也经常看别人的分享文章,本篇就简单梳理梳理个人的一些看法,希望能给一些准备写技术分享的同学一点帮助。 优先确定技术文章面向的受众 。 是初级、中级还是高级、资深人员,面向不同的人群,所需措辞也不同,同一个词因人不同的知识结构会导致不同的解读,所以尽量减少这种不必要的消化损耗。文章真正被阅读的受众,这个是无法控制的,事先定好基调就比较容易把握文章深度,浅显易懂最好不过了。 其次要 考虑到技术应用的上下文环境 ,这个要交待清楚,能解决什么问题,适用在什么场景下,如果能把类似的解决方案顺便提一下,更能阅读受众的知识面。 多使用图表。 一图胜千言,对于晦涩的算法、流程、结构等,一张漂亮的图,那怕是草图,也能使读者很容易走近文章的世界,吸收文章的精华内容。相比满屏的文字,图表会花费较少的时间被阅读接受。 新名词的使用要引出简要的注释,便于读者消化吸引。 由于 知识诅咒 的存在(通俗地说,就是一旦你知道了一个信息(学会了一样东西),你就很难想象你不知道该信息(没学会该东西)的情景。),总会有一些我们常用但别人却不懂的名词存在,这会加大阅读的难度,也会给读者一个放弃文章不再阅读的选择。 如果我在一篇文章中碰到了一个新名词,一般来讲我会去检索弄懂,如果另外的文章中还有,则会引起一连串的检索,那本来我要读的那篇文章就会越为越远离我的视线。当然,我没读完的有兴趣文章