我心目中的好的技术教程
作者:朱金灿
来源:http://www.cnblogs.com/clever101
当人类进入互联网时代,便宣告一个新的学习模式——网上学习的诞生。现在各种网上教程之多可以用恒河沙数来形容(这里暂时除开电子书,单指网页上的短小教程),但是我们应该看到这类教程存在的缺点,总的来说就是:在一篇教程里真理与缪误并存,或缺乏条理,或语蔫不详,可操作性不强。这里我并非批评这些教程作者。应该看到这些教程作者一般是出于分享经验的崇高目的利用自己业余时间来写这些教程的,其心可敬!不过这促使我思考另一个问题:好的技术教程是怎样的?这里的好的标准就是假设一个新手看了这篇教程他就能迅速掌握这篇教程所讲述的技术(我想到一个应用场景是假如在企业内部进行内部培训,你该怎样准备一个好的技术教程)。下面我按照重要性提出好的技术教程应该具备三性。
首先是实践性。这里的实践性可以说是可操作性。IT技术其实是一门实践性非常强的技术,如果在教程里不强调实践性, 新手往往无从下手。那么在一篇教程里怎么体现实践性呢?我想可以从这些方面体现:讲述实践操作时强调步骤和条理;明确开发环境;明确按照操作能得到的操作结果。
其次是原理性。俗语说“知其然还要知其所以然”,知其所以然往往有助于加深对教程的理解。因此很有必要在教授技术的同时介绍其背后的相关理论。
最后是趣味性和思考性。好的教程最好是引人入胜的,至少不会让人觉得枯燥。比如我一般喜欢在技术文章里适当插入图片。因为我觉得图片能够提高读者的阅读兴趣。同时好的教程应该具备思考性,这里的思考性是指教程在告诉别人事实之后会引导读者去思考未知事实,比如孔庆东大侠的博客文章往往在最后留几道博客思考题,我觉得这是一个很好的形式。