引導筆記


導師筆記有兩種:

  1. 特定練習的筆記(用於軌道中某個特定練習)
  2. 特定軌道的筆記(用於軌道中_所有_練習)

這些筆記的目標是:

  • 讓導師引導練習時更輕鬆
  • 讓不同導師引導同一個練習的方式保持一致

導師筆記包含哪些內容?

特定練習的導師筆記通常包含:

  • 合理解法的範例
  • 常見的建議與陷阱
  • 討論要點

特定軌道的導師筆記通常包含:

  • 常見的建議與陷阱(適用於_所有_練習)
  • 實用資源的連結(例如風格指南)

如何新增導師筆記

導師筆記存放在 website-copy 儲存庫 中,檔名格式如下:

  • 練習的導師筆記:tracks/<track-slug>/exercises/<exercise-slug>/mentoring.md
  • 軌道的導師筆記:tracks/<track-slug>/mentoring.md

如要新增導師筆記,請依照上述檔名格式新增檔案並提交 PR。

為什麼導師筆記不放在軌道的儲存庫裡?

維護軌道和撰寫導師筆記是很不一樣的事,需要的技能也不同。 因此,撰寫導師筆記的人不一定要和維護軌道的人是同一批人。

如果我們把導師筆記放在軌道的儲存庫裡,維護者就得在每個導師筆記的 PR 合併前先核准(或至少每次導師筆記有變更時都要被通知)。 把導師筆記存放在 website-copy 儲存庫 中,可以讓我們:

  • 減輕軌道維護者的負擔
  • 讓審查導師筆記的人和軌道維護者可以不同(兩者_可以_重疊)
  • 讓導師筆記能更快疊代(軌道維護者在合併 PR 時通常相當嚴格)