Contents of a good bug report

“The best tester isn’t the one who finds the bugs or who embarrasses the most programmers. The best tester is the one who gets the most bugs’ fixed.”--Cemkaner

Problem report is used to communicate effectively with the programmer. If the reports are not clear and understandable, bugs won’t be fixed. The point of writing problem report is to get bugs fixed. As soon as you run into the problem in the software, fill out a problem report form.

Contents of a good bug report:

• Programmers dismiss reports of the problems that can’t see for themselves so the steps to reproduce the bug must be explained.
• The bug should be analyzed so that it can be described in minimum number of steps. If the steps are lengthy then the developer might postpone dealing with fixing the bug.
• The good bug report should contain diagnosis information like log files and memory dumps, screen shots for the relevant portions of the GUI (example—to show an error message which is inappropriate).
• If there is any relationship with the other bugs, it must be mentioned.
• Context information must be provided.
• The consequences of the bug and the impact of it must be stated clearly. So that the bug is fixed as early as possible.
• The visual glitch of the bug or the video attachments will be an added value to your bug report.
• If the report is confusing it irritates the developer and doesn’t motivate him/her to fix.

Problem report must be written seperately for each bug. The number of problem reports are equal to the number of bugs found.

I have explored on an opensource project called Akelpad (desktop application) and have prepared a problem report.

Akelpad: It is similar to notepad but has some added features than the notepad.

Problem Report Form 1
Program: Akelpad

Problem summary: Program does not let you to retract the changes made in the settings like the background color. Undo is desirable and essential.

Severity: Minor

Can u reproduce the problem: Yes

Problem: Ctrl z/Undo function does not work for settings

How to reproduce it: Open the akelpad applicationà change the settings (like background color)à undo the changes.

Reported by: Rojaramani.k Date: 02/28/07

Problem Report Form 2

Program: Akelpad

Problem summary: Failure to use the shortcut key with the same functionality. Users will expect to work with shortcut keys rather than using a mouse.

Severity: Minor

Can u reproduce the problem: Yes

Problem: The shortcut key Ctrl E for read only mode function is not working

How to reproduce it: Open a new fileàenter the dataàuse shortcut key to change into read only modeàits not working but if you go through the menu bar its working.

Reported: Rojaramani.k

Date:: 02/28/07

Problem Report Form 3

Program: Akelpad

Problem summary: The set of command line parameters where each command has different functionality is showing only one functionality ie.. Creating new file.

Severity: Serious

Can u reproduce the problem: Yes

Problem: All the command line parameters resemble the same feature of creating a new file.

How to reproduce it: Check with all the commands in the command prompt mode.

Reported: Rojaramani.k

Date: 03/05/07

Sources:

Cemkaner

Ashwinpalaparthi

sourceforge.net