یادداشت‌های منتورینگ


یادداشت‌های مربیگری دو نوع دارند:

۱. یادداشت‌های مخصوص یک تمرین (برای یک تمرین مشخص در مسیر نمایش داده می‌شوند) ۲. یادداشت‌های مخصوص یک مسیر (برای همه‌ی تمرین‌های آن مسیر نمایش داده می‌شوند)

هدف این یادداشت‌ها چنین است:

  • آسان‌تر کردن مربیگری یک تمرین برای مربی‌ها
  • یکدست کردن مربیگری یک تمرین میان مربی‌های مختلف

یادداشت‌های مربیگری چه محتوایی دارند؟

یادداشت‌های مربیگری مخصوص یک تمرین اغلب شامل این موارد هستند:

  • نمونه‌هایی از راه‌حل‌های معقول
  • پیشنهادها/دام‌های رایج
  • نکات گفت‌وگو

یادداشت‌های مربیگری مخصوص یک مسیر اغلب شامل این موارد هستند:

  • پیشنهادها/دام‌های رایج (که به همه‌ی تمرین‌ها مربوط می‌شوند)
  • پیوندهایی به منابع مفید (مانند راهنمای سبک نوشتار)

چگونه یادداشت‌های مربیگری را اضافه کنیم

یادداشت‌های مربیگری در مخزن website-copy و با الگوهای نام‌گذاری فایل زیر ذخیره می‌شوند:

  • یادداشت‌های مربیگری تمرین: tracks/<track-slug>/exercises/<exercise-slug>/mentoring.md
  • یادداشت‌های مربیگری مسیر: tracks/<track-slug>/mentoring.md

برای افزودن یادداشت‌های مربیگری، یک PR ارسال کنید که فایلی را مطابق الگوهای نام‌گذاری بالا اضافه می‌کند.

چرا یادداشت‌های مربیگری در مخزن مسیر نیستند؟

نگهداری یک مسیر با نوشتن یادداشت‌های مربیگری کاملاً متفاوت است و مهارت‌های متفاوتی می‌طلبد. بنابراین، کسانی که یادداشت‌های مربیگری می‌نویسند لزوماً نباید همان کسانی باشند که مسیر را نگهداری می‌کنند.

اگر یادداشت‌های مربیگری را درون مخزن مسیر نگه می‌داشتیم، نگهدارندگان باید پیش از ادغام، هر PR مربوط به یادداشت‌های مربیگری را تأیید می‌کردند (یا دست‌کم برای هر تغییر در یادداشت‌های مربیگری باخبر می‌شدند). ذخیره‌ی یادداشت‌های مربیگری در مخزن website-copy به ما امکان می‌دهد:

  • بار نگهدارندگان مسیر را کاهش دهیم
  • افراد بازبین یادداشت‌های مربیگری بتوانند با نگهدارندگان مسیر متفاوت باشند (هرچند می‌توانند هم‌پوشانی داشته باشند)
  • یادداشت‌های مربیگری سریع‌تر به‌روزرسانی شوند (نگهدارندگان مسیر هنگام ادغام PRها اغلب سختگیرند)