メンタリングノート


メンタリングノートには2種類あります。

  1. 演習固有のノート(トラック内の特定の1つの演習について表示されます)
  2. トラック固有のノート(トラック内のすべての演習について表示されます)

これらのノートの目的は次のとおりです。

  • メンターが演習のメンタリングをしやすくする
  • 誰がメンターをしても、演習のメンタリングが一貫するようにする

メンタリングノートには何が書かれているのでしょうか?

演習固有のメンタリングノートには、よく次のような内容が含まれます。

  • 妥当な解答の例
  • よくある提案やつまずきやすい点
  • 話し合いのポイント

トラック固有のメンタリングノートには、よく次のような内容が含まれます。

  • よくある提案やつまずきやすい点(すべての演習に当てはまるもの)
  • 役に立つ情報へのリンク(スタイルガイドなど)

メンタリングノートの追加方法

メンタリングノートは、次のファイル命名パターンでwebsite-copyリポジトリに保存されています。

  • 演習のメンタリングノート: tracks/<track-slug>/exercises/<exercise-slug>/mentoring.md
  • トラックのメンタリングノート: tracks/<track-slug>/mentoring.md

メンタリングノートを追加するには、上記のファイル命名パターンに従ってファイルを追加するPRを送ってください。

なぜメンタリングノートはトラックのリポジトリにないのでしょうか?

トラックの保守は、メンタリングノートを書くこととはかなり違い、求められるスキルも異なります。そのため、メンタリングノートを書く人と、トラックを保守する人は、必ずしも同じである必要はありません。

もしメンタリングノートをトラックのリポジトリに保存するとしたら、メンテナーはメンタリングノートのPRをマージする前に承認する必要があります(少なくとも、メンタリングノートが変更されるたびに通知を受け取ることになります)。

メンタリングノートをwebsite-copyリポジトリに保存することで、次のことができます。

  • トラックのメンテナーの負担を減らせる
  • メンタリングノートをレビューする人を、トラックのメンテナーとは別にできる(重なることもあります)
  • メンタリングノートをより素早く改善できる(トラックのメンテナーはPRをマージするときにかなり厳しいことが多いため)