How to Write a Good Bug Report

A good bug report will lead the computer programmer to the error in the software that needs to be fixed. Without accurate and concise information, the programmer will not be able to find the glitch and correct the coding to make the bug correct itself. Bug reports should be limited to the immediate problem and the details of that problem. Remember to keep them clear, concise and understandable so the programmer understands what they are looking for and can locate the problem quickly.

Difficulty: Easy

Instructions

1. A good bug report will include all the relevant information available, including your name, email address, the software or product you are using, the version of the software or product you are using, the importance of fixing the bug-does it have a major impact on the program, or is it minor--the place or URL the bug occurred on, a summary of the bug and the description of what the bug does.

2. Classify the bug. A computer bug will fall into one of five categories. It will be a coding error, design error, suggestion to prevent future bugs, documentation error or hardware error. include this information in your report. It helps the computer programmer find it easily.

3. Write how to produce the bug. Make the bug appear four times before you report it. When you report it, write down a clear sequence of events that is needed to reproduce the bug. If you don't know how the bug showed up to begin with, there is a problem. The programmer will not be able to fix a bug that they cannot produce.

Tips & Warnings

• Don't use ambiguous or misleading wording. Don't use the bug report as a chance to criticize the programmer.

References

• Report Bugs Effectively