Writing a bug report: example

Below there's an example of a defect entry you could create after finding a defect in an application. Many defect tracking tools exist and they can have different input fields, but the basics remain the same. I like to distinguish two types of bug reports.

The first defect entry is a typical example of an exception raised by the application. In most cases they're easy to spot as an error message is displayed when executing the functionality. A log extract as attachment is the key information for the developer to solver the problem.
The second defect entry is an example of a wrongly or partially implemented functionality. In those cases it is useful to add a reference to the specification document where is described how the application should actually behave.

In both cases your goal is to give as accurate information as possible to the developer. With your information he should be possible to reproduce the defect and to identify the cause.

Exception

headline: exception when saving new customer

defect ID: (automatically created by the defect management tool)
defect status: (default value: opened/created)
originator: (automatically filled in with your username)

application: {list} customer application
functionality: customer creation
release noticed: {list} XX.YY.ZZZ
build: 319
responsible: {list} a developer
priority: high {low - medium - high}
importance: important {nice to have - useful - important - critical}
release scheduled: {list} (to be selected by Development/Releasemanager)
release fixed: {list} (to be selected by Development/Releasemanager)

description:
1. Logon to the billing application
2. Navigate to the customer creation screen
3. Fill in customer mandatory fields
4. Click the 'save' button
Notice that an exception message is shown.

cfr attachment

attachments:
- screenshot
- log extract


Incorrect functionality

headline: no cancel button present on customer creation screen

defect ID: (automatically created by the defect management tool)
defect status: (default value: opened/created)
originator: (automatically filled in with your username)

application: {list} customer application
functionality: customer creation
release noticed: {list} XX.YY.ZZZ
build: 319
responsible: {list} a developer
priority: high {low - medium - high}
importance: important {nice to have - useful - important - critical}
release scheduled: {list} (to be completed by Development/Releasemanager)
release fixed: {list} (to be completed by Development/Releasemanager)

description:
1. Logon to the billing application
2. Navigate to the customer creation screen
3. Fill in customer mandatory fields
Notice that no 'cancel' button is shown. According to the user interface specification page/chapter x, a cancel button should be present.

cfr attachment

attachment:
- screenshot
- eventually an extraction of the user interface specification document



note:
{list} -> this means that only predefined values can be selected.

Related Posts by Categories

Comments

0 Responses to "Writing a bug report: example"

Post a Comment

Recent Articles

Top Commenters

Recent Comments