10 Critical Elements of a Bug: Day #1
Go To: Day 1 - Day 2 - Day 3 - Day 4 - Day 5 - Day 6 - Day 7
Every bug is made up of multiple, individual parts. Singularly, each piece (or Element) contributes to the integrity of the “whole” of the bug. Leave out one Element and your bug is incomplete. Omit just one Element and your work will look like that of an amateur.But if you can master the content and use of each Element detailed in this course, your bug writing skills will make you and your QA team proud. You will demonstrate the unerring accuracy of a true Quality Assurance Professional.
The 10 Critical Elements of a Bug
- Brief Description
- Expanded Description
- Reproducibility
- Steps to Reproduce
- Result
- Expected Result
- Severity
- Priority
- Status
- Assignee
There are other elements that may be necessary for your bugbase, but these are the most important ingredients to start with because you will need all of them no matter which bugbase you use. Let’s take them one at a time.
Element #1: Brief Description
The Brief Description is a succinct, one line description of the issue you are entering. It should be short enough that anyone browsing a list of issues by only this one piece of information will be able to determine what the issue is.Think of a single computer screen full of single sentence descriptions. The list may be 100 or 500 bugs long. This is how the Brief Description will appear when anyone does a query in the bugbase. The goal to writing the Brief Description is that anyone scanning a list of 500 bugs can easily tell one from another just by the Brief Description. Sometimes it is easiest to write this element last, after you have the bug plainly defined in front of you and clear in your mind. Even if you write this part first, be sure to review it after you have finished writing the rest of the bug to ensure that it is still accurate and clear.
Element #2: Expanded Description
Positioned at the top of the “Bug Description” field, the Expanded Description should be a precise explanation of what has gone wrong. This can be the exact same as the Brief Description, but is also the place where you can go into more detail to make the issue as clear as possible to anyone reading the bug.This is where you can elaborate on the issue and use more than a single sentence to describe what is happening. Even though you can be more verbose here, keep in mind that simplicity should be your guide. Explain as much as is necessary, but no more than that. K-I-S-S.
"I don't care if it works on your machine! We are not shipping your machine!" ~Vidiu Platon
Go To: Day 1 - Day 2 - Day 3 - Day 4 - Day 5 - Day 6 - Day 7Return To Successful Quality Assurance Home
|