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

[ech0x]

RT

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

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

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

[Dex7er]

有种东西叫做，知识的诅咒。。。作者讲的东西，很多都有背景知识，他自己知道也就默认读者都知道，但是很多读者是真的不知道，所以。。。公认的好的教程大概就是由浅入深的废话比较多的奥莱丽的那种吧。。。

[MrOange]

如果是程序相关的话，有基础概念，有实例，逻辑连贯。

[no1xsyzy]

自顶向下（或称倒金字塔）
(*)（= #3-1 ）可精细引用
(*)（针对 #21 ）标明至少两个候选前置（“本教程将假定读者拥有 XX 方面的知识，如果对这方面没有相应知识的，请先阅读《 YYY 》或《 ZZZ 》”）
给出后续书目（“如果想要深入了解 XX 方面，可以参考《 YYY 》”）
(*)可机械地复现
如果有可拓展的部分，内链 > 脚注 > 展开
(*)（≈#20 ）搞清楚自己是：给大众读的 “科普” OR 领进门的 “入门” OR 针对某一话题深入的 “专精”
对于自己不甚明了的，明确指出自己不甚明了，而不是 “可能……可能……”
没有错别字
排版良好

其中，标记星号的行是特定于 “教程” 的，不带星号的行是针对 “所有非文学” 的。

[no1xsyzy]

@no1xsyzy 我似乎写了个《关于如何写教程的教程》，但却违反了 2.
因为是残篇所以不符合 1.、3.、4. 应该没啥问题
修正：
5. 应仅指 “操作步骤”
6. 中 “内链” 应为 “链接”
10. “排版良好” 应为 “排版正确”
添加 11. 应选用可以编辑的平台（比如在 V2 就不好），但在编辑时应保留编辑记录（ Change log ），尤其删去列表内一个条目时应保留该条而添加删除线并声明其错误，避免引用的混乱（整章节删除时可删除其正文和下属子标题，但应保留章节标题加删除线，并添加一个子标题 “删除原因” ，后续正文声明整段删除的原因）。

[no1xsyzy]

不过看回复好像很多人说的是 “如何写”，而不是 “如何分辨” [1]
分辨的话大概采用 1. 3. 4. 就行了

说道如何写，想起某个钱学森被下药忘记所学、结果靠笔记全部给找回来的都市传说
不妨想象着 “假如我有天失忆了，我能靠这个重新掌握我所知的一切吗？” 来写

[1]: 当然，我承认我 #23 也有点这样

[no1xsyzy]

不过，警惕 Goodhart 定律：当任何措施本身成为目标时，它便不再是好措施。

[PbCopy111]

首先，要看日期。。。。我经历过好几次看着教程学习，到最后发现是过时的东西。。。

[drawstar]

详细，越啰嗦越好

[userdhf]

1. 用词要书面化和严谨，
2. 要有对专业名词的解释附录
3. 要将技术原理和相关涉及讲清楚
4. 有简单易懂或者贴近开发的代码、注释

[wsx001]

找本书看比看博客要好点，写博客的人水平层次不齐，鱼龙混杂，而出名的书往往就那么几本，里面很有可能会有你想要的答案

[wangxin13g]

如果是具体技术就是官方手册，如果是非具体技术 比如编程范式这种，非 CSDN 掘金 博客园 简书 知乎这种低门槛网站的可能比较好

[crclz]

官方文档，例如微软的 docs

[ysyk]

看你是想要什么了，有的是 step by step，有的是立即解决问题。
两种场景是不一样的。
新学一个东西时，想要的是 step by step。
使用中，遇到问题，想要的是立即解决问题，FAQ 等。
没有好坏，只是你正好遇到错误的“教程”。

[no1xsyzy]

@ysyk 如果一个 “step by step” 的教程添上一个便利的搜索功能，可能符合 80% 的 “立即解决问题”
我甚至见过纸质书，前面有分门类的目录，后面有 A-Z 目录，把所有术语列出来，想要立即解决问题时可以迅速找到。除此以外，List of (Diagrams/Tables/Listings) 也是很有帮助的东西。

[ysyk]

@no1xsyzy 你说的很完美。
你指的这种，很类似大英百科全书。

但现实是很多工具、框架、编程语言，是在用爱发电，没有那么多精力去维护一份完美文档教程。

有很多时候，不是所用的工具 /框架 /编程语言出了问题，而是运行环境问题，那应该是提供工具 /框架 /编程语言的人或组织去维护解决运行环境的问题，编写教程？这个时候就需要确定教程的范围。

docker 的流行，从侧面反映了上面描述的问题。

提供工具 /框架 /编程语言的人或组织，嫌弃那些经常出现环境问题重复，就打包一个标准化镜像。

[instruction]

先推荐一些非常基础的书藉看完，之后再配合书藉简明易懂的增添去伪的讲解之后再加以实例说明,，，，大概这种？

[daimubai]

那就是不要只看一个教程，结合看，我学习技术是：经典视频快速过一遍-> 最少两本书籍(主要加强印象和概念) -> 再看一遍视频(实战) -> 找题或者撸功能 -> 做笔记，写博客 完了