Tips to write better Bug Reports

Writing defect reports is a constant part of a tester’s daily life, and an important one too! How you report the bugs you find plays a key role in the fate of the bug and whether it’s understood and resolved or ends up being deferred or rejected.

It is imperative for every tester to communicate the defects they find well. In my article published at TestRail blog, I discuss four simple tips to help you write better bug reports.

Study past bug reports

If you are new to your team or new to testing itself, the best way to learn about good bug reporting is to read the team’s past bug reports. Try to understand the bugs and see if you could reproduce them. 

By doing this exercise you learn the best way to present bugs so that the team can understand them. You’ll get a feel for the business language and the project’s jargon to be able to describe features and modules.You may also see some imperfections in the past reports, so you can think about how to improve them and what other information would be useful to include.

Create your own game plan

Create a shortcut for yourself, like writing down a summary or title of each bug you find as you go about testing and saving the screenshot. When you get down to reporting, you can quickly fill out the steps, as well as expected and actual results, and attach the saved screenshots. Doing this could be faster and save you the effort of repeating steps just to get the needed screenshots and logs. Continue Reading–>

Keep a checklist

Most defect tracking tools require a certain number of fields to be filled out when submitting a defect report, which is a good way to know if you added enough information. It is typical to include some kind of “proof” of the bug, like a screenshot of the erroneous stage, a video screen recording or a failure log.

You could also keep a track of your previous bug reports to know what additional information the developers asked you for later, like some additional log files or stack traces to help them fix the issues. Continue Reading–>

Mind your language

Writing anything requires certain communication skills. When writing defect reports, you need to focus on not only the content, but also the language you use in order to clearly communicate the problem and create the right impact.

  • Use short sentences
  • Write in a crisp and meaningful way, eliminating unnecessary back story or information
  • Do not use personal nouns or direct personal references
  • Write clear, numbered steps to reproduce the bug (even if you feel they are obvious, they may not be for someone new reading the report for the first time, or after a number of years when the application has changed)
  • Keep the report unambiguous. If the bug is inconsistent, let it be clearly known
  • Write an expected result. If it is not obviously known, express an option you think could be a valid result. Leave the decision to the team and the product owner

Read the full article here – >

Image credits

Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s