现在网上有非常多的「教程」,那么什么是好的教程呢?

2020-01-02 20:35:37 +08:00
 ech0x

RT

如今你想在网上学某样东西,你基本上都可以搜到对应的教程,但是这些教程有好有坏,我们基本上凭借直觉在分辨一个教程的好坏,坏的教程会误导人浪费人的时间,好的教程可以让学习者事半功倍。但是究竟什么样子的教程算得上好的教程呢,或者说好的教程具有什么样子的特征呢?

我觉得我们应该思考一下这个问题,思考这个问题不仅可以帮助读者寻找一份高质量的教程,也可帮助作者创作出一份高质量的教程。

那么在诸位的心中什么样子的教程是一个好的教程呢?

6406 次点击
所在节点    奇思妙想
37 条回复
locoz
2020-01-02 21:07:15 +08:00
个人认为,一个好的教程至少要保证逻辑清晰、内容明确、表述无歧义这三点。
(其实很多写“教程”的人连逻辑清晰都做不到,特别是一些 CSDN、博客园上的文章...逻辑极其混乱,一会儿讲这个一会儿讲那个,然后核心部分又理不清,属于典型的写了还不如不写的类型
ma836323493
2020-01-02 21:26:16 +08:00
按照金字塔原理写的文章,看下腾讯或者美团一些大厂的技术公众号,感觉都有深度且易理解,或者阮一峰或左耳朵耗子
cvbnt
2020-01-02 21:40:57 +08:00
条理清晰是最基本的,我理解很多人写代码很喜欢写注释,但如果是中文教程里步骤和注释混杂写在一起对看的人就是灾难,更有甚者会补点感动自己的心灵鸡汤,这种只能称之为个人随笔,在我看来好的教程至少要有:
1,步骤分段标序号(方便提问者提问)
2,步骤注释用不同字体或者括弧补充
3,尽量不写和教程无关的东西
cmdOptionKana
2020-01-02 21:41:15 +08:00
golang 的 blog,真正做到了深入浅出,优秀到无与伦比。
Justin13
2020-01-02 21:44:04 +08:00
看微软的出的教程你就知道什么叫做好的教程了
1O
2020-01-02 21:44:59 +08:00
引人入胜
garlics
2020-01-02 21:56:05 +08:00
廖雪峰和阮一峰那样的
Sapp
2020-01-02 23:22:02 +08:00
其实好的教程我感觉大多数都是在自己的博客里写的,类似于掘金、专栏、csdn 里面个人感觉大多数都不怎么样,但是个人博客就存在一个很难解决的问题,除非你是阮一峰那个级别,搜索权重很高,不然你是很难找到他们的,往往是偶尔搜索一些问题从他们那里获取答案才发现这个人写的不错。
至于怎么算写的不错呢,我觉得大概有这几点,首先是要格式清晰,不能代码直接当文本粘贴,不然阅读起来太费劲了,你甚至都很难搞清楚他写的什么东西。其次逻辑要有条理,能让人顺着思路一步步摸清楚,不能跳跃幅度太大,也不能太过于啰嗦。然后就是文章要有深度,不能简单地一句话解决了问题然后就结束了,最好是能顺着这个问题讲清楚整个流程,比如按系列讲解某一个方向的方方面面,达到知其然也知其所以然的结果。最后就是写的文章最好不要拘泥于某个问题本身,要有自己对于事情更为深度的思考。
QUIOA
2020-01-03 00:40:50 +08:00
编程随想那样的
green15
2020-01-03 01:21:59 +08:00
国外那把人当傻子一样教的教程最好,具细无遗,你学习会联想到的问题在教程中都能直接找到答案,不用再去另外耗费精力找答案。
很多人写教程潜意识是认为读者这也会那也会,最后写出来的只是面对自己的总结,而不是他人的教程。
dji38838c
2020-01-03 01:51:41 +08:00
中文的就很少有好教程
momocraft
2020-01-03 02:18:03 +08:00
容易重现
不失真 (简化可以接受, 但不能把人带到沟里)
falcon05
2020-01-03 02:29:01 +08:00
好的教程应该是准备充分,了解受众群体,油管有很多老外的编程系列教程做得挺好的,逻辑清晰,简单明了,而且还持续更新,不像国内某些教程啰哩啰嗦,半天说不到点子上。
dawn009
2020-01-03 04:01:29 +08:00
@green15 #10
@falcon05 #13

是的。这些写作训练本应当在中学时代传授给学生,可惜作文课给教成八股文了。
BiteTheDust
2020-01-03 07:24:00 +08:00
好的教程至少格式整洁有调理,该用 LATEX 的用 LATEX,该用代码展示框的用展示框吧
q8164305
2020-01-03 09:00:46 +08:00
国内很多教材最大的问题是忽略上下文和思维跳跃,如果你只是写给自己看的当然可以忽略,但是用户会看的一脸懵逼
SakuraOjosama
2020-01-03 09:10:49 +08:00
好帖子共性☞由浅入深剖析问题 //
帖子界毒瘤——复制粘贴,排版混乱,机器翻译,通篇代码,发帖感想,谈人生,谈自身缺陷(劳资来找教程,谁稀罕你这辣鸡鸡汤),或大幅前言谈天谈地谈神仙,然后最后一条代码草草结束
Virace
2020-01-03 09:28:45 +08:00
这东西感觉还看自己,你觉得这个教程你能看懂,之后还能理解举一反三,那这个对你来说就是好教程!另一个吹的再好,再多的人来宣传,看几分钟看不下去别是白扯!
locoz
2020-01-03 10:18:06 +08:00
@Sapp #8 然而绝大多数的博客都是随笔...逻辑比发在其他平台上的文章更加混乱;少部分写得好的一般也都会在其他平台有发布或者被人转载,所以其实搜索权重这个真不是啥大问题。
locoz
2020-01-03 10:24:33 +08:00
@green15 #10
“你学习会联想到的问题在教程中都能直接找到答案”
这种教程会太细了,篇幅过长,很多人跟我反映过这个问题。个人觉得还是要视情况而定。

像有些本身内容就是讲原理、拓展知识面的教程,做得很细没问题;
但是如果是内容偏实用的教程,这么做就会显得很啰嗦了,细节部分直接引导到别的教程(比如就提一下关键词)反而更好。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/634576

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX