توافقنامهها و قراردادهای تیم
در این سند
مقدمه
این بخش توافقهای ضمنی و شفاهی را که تیم ما در طول توسعه رعایت میکند، مستند میکند. با مستندسازی این قراردادها، ما به دنبال دستیابی به اهداف زیر هستیم:
- ایجاد شفافیت برای اعضای جدید تیم
- اطمینان از یکنواختی در پایگاه کد
- کاهش سوءتفاهمها و تعارضات
- حفظ دانش سازمانی
انواع توافقنامههای تیم
توافقنامههای تیم ما در چند دسته قرار میگیرند:
نحوه استفاده از این مستندات
هر توافقنامه شامل موارد زیر است:
- زمینه: دلیل وجود توافقنامه
- جزئیات: قوانین یا دستورالعملهای خاص
- مثالها: مثالهای عملی از رعایت توافقنامه
- استثناها: مواردی که انحراف از توافقنامه قابل قبول است
مشارکت در توافقنامههای تیم
توافقنامههای تیم اسناد پویایی هستند که با بلوغ تیم و پروژه ما تکامل مییابند. برای پیشنهاد تغییرات:
- تغییر پیشنهادی را با تیم در میان بگذارید
- توافقنامه را با مثالهای واضح مستند کنید
- یک درخواست کشف (Pull Request) برای بهروزرسانی مستندات ارسال کنید
- تأیید حداقل دو نفر از اعضای ارشد تیم را دریافت کنید
یادداشت
همه توافقنامههای تیم نیاز به مستندسازی رسمی ندارند. این مستندات بر روی توافقنامههایی تمرکز دارد که تأثیر قابل توجهی بر کیفیت کد، بهرهوری تیم یا قابلیت نگهداری پروژه دارند.
مراحل بعدی
توافقنامههای خاص تیم را در بخشهای زیر بررسی کنید: