10 things to avoid in your software bug report

Software Testing

10 things to avoid in your bug report

Quality Partners™ www.sq-partners.com

© 2014, Quality Partners™

By: Belal Raslan (Quality Consultant)

• 2

Part 9 : Test Reporting and Monitoring

How to write effective Bug report

(C) 2014, Quality Partners™

1. Report the pattern not an example.

2. Don’t describe what's wrong, only!

3. Be direct to the point (don’t tell a story!).

4. Report the bug, but not how to solve it.

5. Don’t mix between priority and severity.

6. Don’t use: CAPS, red letters, red circles, ‘!’ , ‘?’.

7. Don’t use your personal judgment.

8. Make your description understandable for everyone.

9. Minimize the options.

10. Don’t use the word ‘Sometimes’.

• 3




1. Report the pattern not an example.

Avoid this:

When multiplying -2 by 3 then answer will be positive.

• 4




2. Don’t describe what's wrong, only!

Avoid this:

When adding a new item, the items list will be ordered alphabetically.

• 5




3. Be direct to the point (don’t tell a story!).

Avoid this:

Open your browser, type the site URL, go to home page, login as user, go to ‘add item’, you’ll find the first field ‘usernam’ misspelled.

• 6




4. Report the bug, but not how to solve it.

Avoid this:

The ‘ID’ field in the report is incomplete, please define the ID in the data base as integer of (10).

• 7




5. Don’t mix between priority and severity.

Avoid this:

The client name in the report is misspelled.

Priority: High, Severity: High

• 8




6. Don’t use: CAPS, red letters, red circles, ‘!’ , ‘?’.

Avoid this:

The tax calculation formula is INCORRECT !!??

• 9




7. Don’t use your personal judgment.

Avoid this:

I don’t think that the home page UI design is nice.

• 10




8. Make your description understandable for everyone.

Avoid this:

Reference to our discussion today, please do the needed action for this page.

• 11




9. Minimize the options.

Avoid this:

Page background color should be blue or orange or green or you can make it black or even white.

• 12




10. The golden rule: Don’t use the word ‘Sometimes’.

Avoid this:

Sometime the tax calculation formula is not working as

expected.

• 13

Author:

Belal Raslan (Quality Consultant)Email: [email protected]: @BelalRaslan

7 reasons why testing should start early in the SDLC

mailto:[email protected]

10 things to avoid in your software bug report

Technology