一节课包含什么

5 分钟
目标官方课程中每节课都具备的六个部分,以及为什么示例不是可选的。

学习者打开一节课时只问一件事:学完之后我能做什么。页面上的一切要么回答这个问题,要么就没有理由出现在那里。

六个部分

部分 必需 内容
标题 · 一句话目标 是 学完后能做到的事,一句话
正文 是 英语、韩语、日语、简体中文的 Markdown
可运行示例 是 示例仓库中的文件夹、运行命令及其结果画面
练习 是 用来自我确认是否理解的小任务
视频 · 短视频 否 YouTube 视频 id
相关文章 否 杂志链接

示例就是课程本身

无法运行的课只是说明文字。示例必须只靠自己的文件夹、只用已发布的包就能构建——不能指向别人的检出路径,也不能用未发布的分支。复制文件夹、执行命令,课中的画面就应当出现。

一节课一个主张

拆分的依据不是资料的结构,而是学习者一次能带走什么。如果需要两次「现在试试看」,那就是两节课。

团队课程也是同样的形状

开设付费课程的团队同样遵守这个形状。这样付费课程才能指回它所深化的免费路径。

练习任务

自己设计一节课:一句话目标、示例文件夹与命令,以及练习。