导师笔记


指导笔记有两种:

  1. 针对具体练习的笔记(只会在学习路径中某个特定练习里显示)
  2. 针对整条学习路径的笔记(会在学习路径中_所有_练习里显示)

这些笔记的目的是:

  • 让导师更容易指导练习
  • 让不同导师对同一个练习的指导保持一致

指导笔记包含哪些内容?

针对具体练习的指导笔记通常包含:

  • 合理解答的示例
  • 常见的建议和坑
  • 讨论要点

针对整条学习路径的指导笔记通常包含:

  • 适用于_所有_练习的常见建议和坑
  • 有用资源的链接(比如风格指南)

如何添加指导笔记

指导笔记存放在 website-copy 代码仓库 中,采用以下文件命名方式:

  • 练习指导笔记:tracks/<track-slug>/exercises/<exercise-slug>/mentoring.md
  • 学习路径指导笔记:tracks/<track-slug>/mentoring.md

要添加指导笔记,请提交一个 PR,按上面的文件命名方式新增一个文件。

为什么指导笔记不放在学习路径的代码仓库里?

维护一条学习路径和撰写指导笔记是两件相当不同的事,需要的技能也不一样。 因此,撰写指导笔记的人不一定就是维护学习路径的人。

如果把指导笔记存放在学习路径的代码仓库里,维护者就必须先批准所有跟指导笔记有关的 PR,之后这些 PR 才能合并(至少每次指导笔记有改动,他们都会收到通知)。 把指导笔记存放在 website-copy 代码仓库 里,可以让我们:

  • 减轻学习路径维护者的负担
  • 让审核指导笔记的人与学习路径维护者不必是同一批人(他们_可以_重叠)
  • 更快地迭代指导笔记(学习路径维护者在合并 PR 时往往相当严格)