清晰易读的文档理当是什么样的?

Updated on

噫嘘唏,复杂兮冗长哉!

相信很多新手读文档都体会过类似的问题:文档详细十分,说理透彻,往往还伴随着的丰富的发散知识。新手通读下来理解通透,神清气爽。可当回顾细节之时,就犯了难:文章概念、说理、发散知识点交织在一起,一眼下去无法快读定位想要的内容。往往只能反复拉动进度条,苦恼十分。

基于此,我认为优秀的教程理当结构合理,排版恰当,不仅能让人初次通读时理解流畅,二次复读时还能快速找到需要的内容。

要做到这点,就得合理安排核心信息、名词解释和注释文字。从排版上解决相对容易,核心信息整理成大纲,来几句简要说明,后面再接一下清晰列明的名词解释。至于注释文字,就搞一个角标,鼠标悬移上去显现文字就好——奈何,我的主题不支持!那我只好用各种样式,尽量压缩不必要的说明性文字,让整个文章显得清爽些了。