תיעוד באגים

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

בכל תהליך בדיקות תפגשו סוגים שונים ומגוונים של באגים ברמות שונות. כל באג או דפקט שנחשף בפניכם חשוב לתעד ממספר סיבות, ביניהן; היכולת להריץ בדיקות רגרסיה, מעקב תיקון באגים, סטטיסטיקות על איכות, עדכון אוטומטי לכל המעורבים בפרויקט, מיקוד בדיקות באזורים מרובי באגים ועוד.

כל חברה ואופן העבודה וההרגלים שלה וביניהן סוג השרת והתוכנה בה משתמשים. בין אם אתם עובדים עם;
Quality Center, OnTime2007, Synergy, Mircrosoft virtual Studio2010 או כל תוכנה אחרת, תיעוד הבאגים תמיד יהיה זהה במהותו ואני אתמקד במה חשוב לדעת ולא על אופן ההזנה הטכני (אותה תרכשו לרב במהלך החפיפה).

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

אז אחרי שנגעתי בכל מה שמסביב נעבור לעיקר:

Summery\Title - שלב ראשון תזינו את כותרת הבאג במשפט שמסכם את התקלה. שדה זה הראשון שנצפה על ידי המפתח ולפעמים אתם תזדקקו לו בניסיונות חיפוש אחר באג ספציפי, לכן חשוב שיהיה תמציתי אך ברור וקל למציאה. (דוגמה: אפשר לכלול נתיב ומקור הבעיה כמו; Project Name > Module > Screen Name > The defect function).

Project\Area - בכל חברה ישנם מספר פרויקטים לכן תמיד מומלץ לשייך שדה זה לפרויקט. לרב ייוצג כפקד בחירה מרשימת פרויקטים קיימים.

Priority & Severity - לרב Severity יקבע אל פי חומרת התקלה וPriority ייקבע עבור עדיפות התיקון בפרויקט. ישנן חברות שצוות הפיתוח או ר"צ שלכם יקבע את הPriority ולא אתם.

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

  1. התחילו ברישום כללי מסכם של התקלה - תמציתי ופשוט.
  2. רשמו את הדרך שהגעתם אל התקלה בשלבים (:Scenario\Steps).
  3. רשמו את התוצאה שקיבלתם (Result).
  4. רשמו מה התוצאה הצפויה לפי מסמך האפיון (Eexpected) וכללו קישור למסמך אם יש לכם כזה.
  5. אם מדובר במערכת משתמשים בעלת רמות הרשאה שונות צרפו למפתח את פרטי המשתמש עימו עבדתם.
הפרטים שלכם אמורים לכלול שינויי הגדרות במערכת והכל בצורה ברורה שגם אתם תוכלו לשחזר בבדיקות רגרסיה.

Attachments - רבים מוותרים על אופציה זו אבל זה השדה האהוב עליי ביותר. כאן יש לכם אפשרות לצרף צילומי מסך, קבצים איתם עבדתם ועוד. נצלו את השדה הזה לתת אור על כוונתכם.

יתכן ותמצאו שדות נוספים על הנ"ל, שצוות הפרויקט הוסיף למטרות ייעול ושיפור התהליכים (כמו: רגרסיה: כן/לא, מספר גרסה וכד').


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

רשימת מערכות צד שרת חינמיות:
Ontime2007
Bugzilla
WebIssies

הכלים האלו מותקנים כשרת Web ומאפשרים לכל העובדים לגשת אליהם ולכן ממליץ לתת לעובד התמיכה שלכם להתקין כדי לא להלאות אתכם במידע נוסף כמו התקנת IIS וכד'.




תגובות

פוסטים פופולריים מהבלוג הזה

אמולטור למכשירי אנדרויד - כלי קטן חוסך זמן

באגים קשים לשחזור - הפעם מובייל

בדיקות במכשירים ניידים - Mobile