הסוכנים קוראים את המאגר שלכם. זה מספק להם את רוב המידע הדרוש – אך לא את ההחלטות שנמצאות בראשם של אנשים, בוויקי או בשיחה מלפני שנתיים.
הקשר הפרויקטיאלי הוא המקום שבו תוסיפו את השאר.
מה ש־Coroid מסוגל לקבוע לבד
רק מהמאגר, הסוכנים יכולים לראות:
- השפות, המסגרות והספריות שבשימוש
- כיצד הפרויקט נבנה, נבדק ומופעל
- התבניות הקיימות – כיצד מתבצע טיפול בשגיאות, כיצד מובנים המודולים, כיצד נקראים הדברים
- מה תלוי במה
אין צורך לתעד דבר מכל אלה. חזרה על המידע הזה היא בזבוז מאמץ ומסכנת את עדכניותו ביחס לקוד, שהוא מקור המידע האמין יותר.
מה שהסוכנים לא יכולים להסיק
הקוד מציג מה עשיתם, אך לא למה:
- סיבה לבחירת ספריה מסוימת על פני חלופה ברורה, כשהסיבה עדיין רלוונטית
- תבנית שנראית כפילות אך היא חלוקה מכוונת
- מודול שאף אחד לא צריך לגעת בו בלי להתייעץ עם צוות מסוים
- כללים שהוסכמתם עליהם אך עדיין לא יושמו בשום מקום
- מגבלות שמקורן מחוץ למאגר הקוד – תקנות, חוזים, או תהליך מעבר בתהליך
זה מה ששייך להקשר הפרויקטיאלי. המבחן פשוט: האם מישהו שקורא רק את המאגר יכול להבין זאת? אם התשובה חיובית, אל תוסיפו זאת. אם לא, רשמו זאת.
הוספת הקשר
צרפו מסמכים, מדיניות ומקורות התייחסות לכותרת ה־ הקשר של הפרויקט. הערות ארכיטקטורה, תיעוד החלטות, מדריכי סגנון וחוזים של API – כולם מתאימים.
הקשר טוב הוא קצר וספציפי. מדריך הכנה של 40 עמודים שנכתב עבור בני אדם הוא בעיקר נרטיב; שלושת הפסקאות שבו שמציינות מגבלות אמיתיות הן אלו שחשובות. הפרידו אותן.
הקשר לפי משימה
ההקשר שנצורף לפרויקט חל על הכל. עבור דברים שרלוונטיים לחלק מסוים של עבודה – כרטיס, מסמך עיצוב, דוח לקוח – צרפו אותו למשימה עצמה.
השאירו את ההקשר הפרויקטיאלי לדברים שנכונים לאורך זמן. הערה ספציפית למשימה שנמצאת בהקשר הפרויקטיאלי הופכת לרעש בכל משימה עתידית.
שמירה על עדכניות ההקשר
הקשר שכבר לא עדכני גרוע יותר מאשר היעדר הקשר, מכיוון שהסוכנים רואים בו מקור אמין. כשכלל משתנה, עדכנו את ההקשר באותה פעולה שמשנה את הקוד.
אם אתם מוצאים את עצמכם מתקנים שוב ושוב את אותו דבר בתגובות לתיקון, זה סימן שחסר הקשר – או שההקשר שגוי.