If you’re new to bug tracking, issue management, or web development in general, you might wonder what a bug report is.
In this blog post, I try to answer this question from different viewpoints. And trust me, it’s not going to be boring.
We Always Talk About Bug Reports…
… but never explain what they are.
I just noticed that we at Usersnap haven’t answered this core and essential question.
However, we haven’t answered this core question... not even once. Though, we did cover a lot of topics in the area of bug reporting.
For example, I’ve shown you 6 easy bug reporting tricks, answered the 4 W’s of bug reporting, and gave you some insights on bad bug reports. I’ve even shown you how to set up a bug-free web development environment.
Nevertheless, I haven’t answered the simple–yet important–question of what a bug report actually is.
But today, I am finally tackling this issue. Ready?
What is a Bug Report?
So, let me answer the question “What is a bug report?” for you.
In order to answer this question, we need to understand the following concept of bugs, bug reports, and bug reporting software.
What is a Bug?
In the context of software development, engineering, or web development, a bug is not—despites its name—a little insect, but something else entirely.
According to Wikipedia a software bug (or just a bug) can be defined as:
“A software bug is an error, flaw, failure, or fault in a computer program or system that causes it to produce an incorrect or unexpected result or to behave in unintended ways.”
So in short, this means:
A software bug is an error, flaw, failure, or fault that produces an incorrect or unexpected result.
Basically, a software bug is something which is not working as designed.
Why is called a bug then? The origin of a bug.
You might wonder, why a bug is called a bug? It’s a great question, because the term bug, describing an software error or failure goes way back to 1945. In late 1945, at the University of Harvard, a technical team found something unusual between points in Relay70. The found a real dead bug (the insect) which caused an error.
As stated in the bug log, it’s the "first actual case of a bug being found."
So, in theory, a bug is something not working as designed.
But, what if something is not designed as it should be? Is it a bug then? As you can see, this question alone leaves a lot of room for interpretation.
No matter if you’re a developer, designer, or user of a software, chances are high that you’ve stumbled upon a bug in the past, or maybe you even caused a bug yourself.
What is a Bug Report?
So, here’s the core question: What is a bug report?
If bugs occur (which they certainly do), the person finding the bug, should be able to report (document & send) the bug to people in charge of fixing that error or failure.
According to Yegor, a bug report "should explain how exactly the product is broken."
He continues that a bug report should follow this simple formula:
"This is what we have, this is what we should have instead, so fix it."
This sounds easy, right? However in practice a bug report and what documentation is included isn’t that clear.
Imagine you encountered a bug and wanted to send in a bug report. What information would you include? I guess everyone would answer that differently.
In the past, bug reports were lengthy forms including various fields and data requests. What’s the priority of the error? What’s the problem description? What are the components? Which browser version are you using? And, so on…
Good vs. Bad Bug Reports
So, you might wonder, what’s the difference between a good bug report and a bad one. And, why are there so many bad bug reports out there?
I collected some statements about this issue in order to distinguish between the two of them:
- A good bug report contains the information needed to reproduce and fix problems
- A bad bug report does not contain the information needed to reproduce and fix problems
- A good bug report is an efficient form of communication for both bug reporter and bug receiver
- A bad bug report is a lengthy, inefficient form of communication for everyone involved
- A good bug report is resolved as fast as possible
- A bad bug report never gets resolved
- A good bug report is sent to the person in charge
- A bad bug report isn’t filed at all
- A good bug report is on point
- A bad bug report contains no specific information
- A good bug report is filed in the defined way
- A bad bug report is filed in any medium available, but not in the defined way (little hint: Twitter isn’t a good way to file a bug report)
- A good bug report establishes a common ground of collaboration
- A bad bug report doesn’t enable collaboration
So, how would I sum up my answer to the question: "What is a bug report?"
A bug report is something that stores all information needed to document, report, and fix problems occurred in a software or on a website. And in the best case scenario: This is done in the most efficient manner possible.
I’ve created this bug reporting checklist in order to get a feeling on what questions a bug report must answer.
Wrapping it up.
All in all, I’ve shown you the basics of bugs, bug reports and bug reporting systems. There are a lot of further do’s and don’ts when it comes to the bug reporting workflow, from bugs, to no bugs.
This post orginally appeared at the Usersnap blog.