Sunday, May 11, 2014

10 tips to write better bug reports

1. Structure - Careful approach to testing and take careful notes.

2. Reproduce - Check reproducibility of a failure before writing a bug report. 

3. Isolate - Proceed to isolate the bug. This information gives developers a head start on debugging.

4. Generalize - Does the same failure occur in other modules or locations? Can you find more severe occurrences of the same fault?

5. Compare - Check whether the bug is a case of regression

6. Summarize - Think through how the failure observed will affect the customer.

7. Condense - Reread focusing on eliminating extraneous steps or words. 

8. Disambiguate - In addition to eliminating wordiness, go through the report to make sure it is not subject to misinterpretation. 

9. Neutralize - Bug reports should be fair-minded in their wording. 


Source : http://www.rbcs-us.com/documents/FineArtofWritingaGoodBugReport(Paper).pdf


No comments: