How To Write A Good Bug Report
How To Write A Good Bug Report
Posted In | Bug Defect tracking, How to be a good tester, Software Testing Templates
If your bug report is effective, chances are higher that it will get fixed. So fixing a bug depends
on how effectively you report it. Reporting a bug is nothing but a skill and I will tell you how to
achieve this skill.
$c%
&
Always assign a unique number to each bug report. This will help to identify the bug record. If
you are using any automated bug-reporting tool then this unique number will be generated
automatically each time you report the bug. Note the number and brief description of each bug
you reported.
'(
&
If your bug is not reproducible it will never get fixed. You should clearly mention the steps to
reproduce the bug. Do not assume or skip any reproducing step. Step by step described bug
problem is easy to reproduce and fix.
)*&
Do not write a essay about the problem. Be Specific and to the point. Try to summarize the
problem in minimum words yet in effective way. Do not combine multiple problems even they
seem to be similar. Write different reports for each problem.
, & Mention the hardware platform where you found this bug. The various platforms like
µPC¶, µMAC¶, µHP¶, µSun¶ etc.
.& Mention all operating systems where you found the bug. Operating systems
like Windows, Linux, Unix, SunOS, Mac OS. Mention the different OS versions also if
applicable like Windows NT, Windows 2000, Windows XP etc.
, &
When bug should be fixed? Priority is generally set from P1 to P5. P1 as ³fix the bug with
highest priority´ and P5 as ´ Fix when time permits´.
*%&
This describes the impact of the bug.
*%&
*&
When you are logging the bug in any bug tracking system then by default the bug status is
µNew¶.
Later on bug goes through various stages like Fixed, Verified, Reopen, Won¶t Fix etc.
Click here to read more about detail bug life cycle.
0 &
If you know which developer is responsible for that particular module in which bug occurred,
then you can specify email address of that developer. Else keep it blank this will assign bug to
module owner or Manger will assign bug to developer. Possibly add the manager email address
in CC list.
+(1&
The page url on which bug occurred.
*&
A brief summary of the bug mostly in 60 or below words. Make sure your summary is reflecting
what the problem is and where it is.
2 &
A detailed description of bug. Use following fields for description field:
These are the important steps in bug report. You can also add the ³Report type´ as one more
field which will describe the bug type.
$(
&If you found any bug while testing, do not wait to write
detail bug report later. Instead write the bug report immediately. This will ensure a good and
reproducible bug report. If you decide to write the bug report later on then chances are high to
miss the important steps in your report.
'(
&Your bug should be
reproducible. Make sure your steps are robust enough to reproduce the bug without any
ambiguity. If your bug is not reproducible every time you can still file a bug mentioning the
periodic nature of the bug.
)
&
Sometimes developer use same code for different similar modules. So chances are high that bug
in one module can occur in other similar modules as well. Even you can try to find more severe
version of the bug you found.
3
&
Bug summary will help developers to quickly analyze the bug nature. Poor quality report will
unnecessarily increase the development and testing time. Communicate well through your bug
report summary. Keep in mind bug summary is used as a reference to search the bug in bug
inventory.
4(
*
&
Read all sentences, wording, steps used in bug report. See if any sentence is creating ambiguity
that can lead to misinterpretation. Misleading words or sentences should be avoided in order to
have a clear bug report.
X2 0
%&
It¶s nice that you did a good work and found a bug but do not use this credit for criticizing
developer or to attack any individual.
&
No doubt that your bug report should be a high quality document. Focus on writing good bug
reports, spend some time on this task because this is main communication point between tester,
developer and manager. Mangers should make aware to their team that writing a good bug report
is primary responsibility of any tester. Your efforts towards writing good bug report will not only
save company resources but also create a good relationship between you and developers.