Mentorálási jegyzetek

Kétféle mentorálási jegyzet létezik:

  1. Feladatspecifikus jegyzetek (egy adott feladatnál jelennek meg a kurzusban)
  2. Kurzusspecifikus jegyzetek (a kurzus összes feladatánál megjelennek)

Ezeknek a jegyzeteknek a célja, hogy:

  • könnyebbé tegyék a mentorok számára egy-egy feladat mentorálását
  • biztosítsák, hogy a mentorok következetesen mentoráljanak egy-egy feladatot

Mit tartalmaznak a mentorálási jegyzetek?

A feladatspecifikus mentorálási jegyzetek gyakran tartalmaznak:

  • példákat ésszerű megoldásokra
  • gyakori javaslatokat/buktatókat
  • beszélgetési pontokat

A kurzusspecifikus mentorálási jegyzetek gyakran tartalmaznak:

  • gyakori javaslatokat/buktatókat (amelyek minden feladatra érvényesek)
  • linkeket hasznos forrásokhoz (például egy stílusútmutatóhoz)

Hogyan adj hozzá mentorálási jegyzeteket?

A mentorálási jegyzeteket a website-copy repóban tároljuk, a következő fájlelnevezési minták szerint:

  • Feladatspecifikus mentorálási jegyzetek: tracks/<track-slug>/exercises/<exercise-slug>/mentoring.md
  • Kurzusspecifikus mentorálási jegyzetek: tracks/<track-slug>/mentoring.md

Új mentorálási jegyzetek hozzáadásához nyújts be egy PR-t, amely a fenti fájlelnevezési mintákat követve hozzáad egy fájlt.

Miért nincsenek a mentorálási jegyzetek a kurzus repójában?

Egy kurzus karbantartása egészen más, mint mentorálási jegyzeteket írni, és más készségeket igényel. Ezért nem feltétlenül ugyanazoknak kell mentorálási jegyzeteket írniuk, akik a kurzust karbantartják.

Ha a mentorálási jegyzeteket a kurzus repójában tárolnánk, a karbantartóknak minden mentorálási jegyzetet érintő PR-t jóvá kellene hagyniuk, mielőtt azokat be lehetne olvasztani (vagy legalábbis értesítést kapnának minden mentorálási jegyzet módosításáról). Ha a mentorálási jegyzeteket a website-copy repóban tároljuk, a következőket érhetjük el:

  • kevesebb teher hárul a kurzusok karbantartóira
  • a mentorálási jegyzeteket nem csak a kurzusok karbantartói nézik át (bár a két csoport átfedésben lehet)
  • gyorsabb iteráció válik lehetővé a mentorálási jegyzeteknél (a kurzusok karbantartói gyakran elég szigorúak a PR-ok beolvasztásakor)