top of page
  • תמונת הסופר/תד"ר מוריה לוי

תיעוד חכם

כבר שנים שאנחנו מתעדים. מתעדים כל מערכת הנדסית אותה מפתחים, כל תכנה אותה כותבים. עוד לפני שידענו שצריך לנהל את הידע, ידענו לחנך לתיעוד. אם לא נתעד, איך נתחזק? שאלנו.

האמנם אנו מתעדים חכם? האם משרת תיעוד זה באמת ובתמים את התוכניתן (או כל בעל מקצוע אחר) בבואו אחר שנתיים לעשות שינויים?

קל לבחון את רמת התיעוד בדיעבד: האם אכן המתחזק הצליח להבין היטב את המודולים? האם נדרש הסבר משלים בעל פה כדי להבינו? האם נדרש לדלות את המפתח המקורי בעצמו לקבלת טיפים והצבעה על מוקשים?

ברוב המקרים התשובה לא תניח את דעתנו. הסיבה לכך פשוטה. ברוב המקרים מתעדים את הברור. מתעדים את הידוע. מתעדים את ה- Streight Forward. לא מסבירים מדוע שורה מסויימת כתובה כמו שהיא אחרי הרבה דם, יזע ודמעות.

מכניזם פשוט יכול לסייע בנושא. על מנהל הפרוייקט לבחון לא רק את קיומו של התיעוד. עליו לשאול את המפתחים מספר שאלות:

  • היכן נתקלת בבעיות חריגות?

  • היכן התעכבת יותר מהמצופה?

  • איפה היו טריקים מעניינים לעקוף בעיות?

שאלות אלו ודומות להן מצביעות על מקומות ונושאים המחייבים תיעוד ייחודי.

מאד פשוט. הכל מתחיל ומסתיים במודעות.

Comments


bottom of page