멘토링 노트


멘토링 노트에는 두 가지 종류가 있어요.

  1. 연습 문제별 노트 (트랙의 특정 연습 문제 하나에 대해 표시돼요)
  2. 트랙별 노트 (트랙의 모든 연습 문제에 대해 표시돼요)

이 노트의 목적은 다음과 같아요.

  • 멘토가 연습 문제를 멘토링하기 더 쉽게 만들어요
  • 연습 문제 멘토링이 멘토마다 일관되게 이루어지도록 해요

멘토링 노트에는 무엇이 담겨 있을까요?

연습 문제별 멘토링 노트에는 보통 이런 내용이 담겨요.

  • 적절한 풀이의 예시
  • 자주 나오는 제안과 주의할 점
  • 대화할 주제

트랙별 멘토링 노트에는 보통 이런 내용이 담겨요.

  • 모든 연습 문제에 적용되는 자주 나오는 제안과 주의할 점
  • 유용한 자료 링크 (스타일 가이드 같은 것)

멘토링 노트를 추가하는 방법

멘토링 노트는 website-copy 저장소에 다음 파일 이름 규칙으로 저장돼요.

  • 연습 문제 멘토링 노트: tracks/<track-slug>/exercises/<exercise-slug>/mentoring.md
  • 트랙 멘토링 노트: tracks/<track-slug>/mentoring.md

멘토링 노트를 추가하려면, 위 파일 이름 규칙에 맞는 파일을 추가하는 PR을 보내요.

멘토링 노트는 왜 트랙 저장소에 없을까요?

트랙을 유지하는 일은 멘토링 노트를 쓰는 일과 꽤 다르고, 필요한 능력도 달라요. 그래서 멘토링 노트를 쓰는 사람이 반드시 트랙을 관리하는 사람과 같을 필요는 없어요.

멘토링 노트를 트랙 저장소 안에 두면, 메인테이너가 모든 멘토링 노트 PR을 병합하기 전에 승인해야 해요 (적어도 멘토링 노트가 바뀔 때마다 알림을 받게 되죠). 멘토링 노트를 website-copy 저장소에 두면 다음과 같은 이점이 있어요.

  • 트랙 메인테이너의 부담을 줄여요
  • 트랙 메인테이너가 아닌 다른 사람이 멘토링 노트를 리뷰할 수도 있어요 (두 역할을 겸할 수도 있어요)
  • 멘토링 노트를 더 빠르게 개선할 수 있어요 (트랙 메인테이너는 PR을 병합할 때 꽤 엄격한 경우가 많아요)