Bug report template

Issue reporting and management is very important to any product, but in the world of computer software, it’s even more important. To keep it simple, software engineers should use only two kind of issue: bug and improvement. You may call them defect and enhancement, but there is no point in complicating the names with very minor difference: “defect, bug, fault, error, failure, mistake, issue”; or “enhancement, improvement, new feature, task, risk, dependency, issue” ; unless everyone’s already familiar to the basic two and ready to approach more advanced classifications.

IMHO, the most important factors to the usability of an issue management system is the reporting templates: bug-report template and improvement-request template.

.

Why template?

+ Because it makes the report more effective and more efficient to both reporters (users/QA) and assignees (developers/supporters) .

.

Why effective/efficient reports are neccessary to assignees?

+ Because they help assignees understand the expectation and reproduce the bug much easier and in less time .

.

Why effective/efficient reports are neccessary to reporters?

+ Because they help reporters write in less time, express the expectation easier, thus reduce the possibility of bug-reject “not reproducible” from assigners. Hence it gets the bug fixed quicker and protect the reporters from moral/ego hurt .

.

Ok, any sample template for bug-report ?

+ Normally, the reporters do NOT CARE about system-management attributes of the issue such as assignee, ID-number, storage, classification, etc… So, an effective template should just focus on the Summary and Description of the defect. Or better, just a Description with bundled Summary and a few essential information such as the below:

SUMMARY: (one-line)

STEPS TO REPRODUCE:
1.
2.

ACTUAL RESULT:

EXPECTED RESULT: 

ADDITIONAL INFORMATION:
Product version:
Environment:
Notes: (workaround, other platform, ...)

.

Is it that short ? I’ve worked with templates that include 20 items at least…

Repeat, keep it simple ! Otherwise the reporters will eventually get frustrated and not bother reporting even smallest bug. No one wants to carry a whole burden just to report a bug, even if it’s his/her job :-) . The assigners also wants to save time and not reading a whole essay for every issue. Unless that’s what you really want, just follow K.I.S.S ;-) .

.

(next is the improvement-request template)

./.

About DucQuoc.wordpress.com

A coder, brother, and player at times...
This entry was posted in Coding, Marketing. Bookmark the permalink.

12 Responses to Bug report template

  1. Pingback: Improvement request template | DucQuoc's Blog

  2. Pingback: Eclipse ExtJS jQuery | DucQuoc's Blog

  3. Pingback: Retain capable developers | DucQuoc's Blog

  4. Pingback: Install PostgreSQL Database | DucQuoc's Blog

  5. Pingback: Singleton In Java | DucQuoc's Blog

  6. Pingback: Developer Productivity Difference | DucQuoc's Blog

  7. Pingback: Software tester objectives | DucQuoc's Blog

  8. Pingback: Vietnamese Flash developers | DucQuoc's Blog

  9. Pingback: Logging best practices | DucQuoc's Blog

  10. Pingback: Avira Temp Place | DucQuoc's Blog

  11. It’s the best time to make some plans for the future
    and it is time to be happy. I’ve read this post
    and if I could I desire to suggest you few interesting things or advice.
    Maybe you could write next articles referring to this article.
    I desire to read even more things about it!

  12. Johnd82 says:

    Fckin amazing things here. Im very glad to see your post. Thanks a lot and i’m looking forward to contact you. Will you kindly drop me a mail? ecfdaakfekdf

Leave a Reply

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

WordPress.com Logo

You are commenting using your WordPress.com 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 )

Google+ photo

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

Connecting to %s