Нотатки для наставників бувають двох типів:
- Нотатки для конкретної вправи (показуються для однієї конкретної вправи в треку)
- Нотатки для конкретного треку (показуються для всіх вправ у треку)
Мета цих нотаток:
- Зробити наставництво над вправою простішим для наставників
- Зробити наставництво над вправою однаковим у різних наставників
Що містять нотатки для наставників?
Нотатки для конкретної вправи часто містять:
- Приклади прийнятних рішень
- Поширені поради та пастки
- Теми для обговорення
Нотатки для конкретного треку часто містять:
- Поширені поради та пастки (які стосуються всіх вправ)
- Посилання на корисні ресурси (наприклад, посібник зі стилю)
Як додати нотатки для наставників
Нотатки для наставників зберігаються в репозиторії website-copy і мають такі шаблони назв файлів:
- Нотатки для вправи:
tracks/<track-slug>/exercises/<exercise-slug>/mentoring.md
- Нотатки для треку:
tracks/<track-slug>/mentoring.md
Щоб додати нотатки для наставників, надішліть PR із файлом, названим за одним із наведених шаблонів.
Чому нотаток для наставників немає в репозиторії треку?
Супроводжувати трек зовсім не те саме, що писати нотатки для наставників, і це потребує інших навичок.
Тож люди, які пишуть нотатки для наставників, не обовʼязково мають бути тими самими людьми, які супроводжують трек.
Якби ми зберігали нотатки для наставників у репозиторії треку, супровідникам довелося б схвалювати кожен PR із такими нотатками, перш ніж його можна буде злити (або принаймні отримувати сповіщення про кожну зміну в нотатках).
Якщо ж зберігати нотатки для наставників у репозиторії website-copy, ми можемо:
- Зменшити навантаження на супровідників треків
- Залучати до перегляду нотаток для наставників інших людей, ніж супровідники треку (вони можуть перетинатися)
- Дозволяти швидші ітерації над нотатками для наставників (супровідники треків часто доволі суворо ставляться до злиття PR)
