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