Write Up Your First Software Bug

You found a bug. Great. Now you need to get that bug into your bug tracking system. But what do you need to include? Making a bug template is a good way to be sure you include all the important parts of the bug.

Bug Template

The bug template should have as much relevant information as you can add so that the developer can easily understand and start debugging the issue. At a minimum the templates should look something like this:

Web App Template

• Title
• Description
• Steps
• Expected Result
• Actual Result
• Browser (type and version)
• Version / Timestamp

Mobile App Template

• Title
• Description
• Steps
• Expected Result
• Actual Result
• Mobile Device (Device version and OS version)
• Version / Timestamp

API Template

• Title
• Description
• Steps
• Expected Result
• Actual Result

Additional info that I will add as appropriate are:

• Screenshot
• Video Playback
• API Request/Response
• TimeStamp
• Logs
• SQL Scripts

Sample

Title:

Submit button is not submitting form

Description:

The form is not submitted after clicking the submit button on the “contact support” page.

Steps:

1. Go to http://glitchitsystem.com

2. Click the “contact support” menu item

3. Fill in a valid email and a message

4. Click the submit button

Expected Result:

The form should be submitted. Support email should be generated. The page should display a confirmation message that message was sent.

Actual Result:

The form is not submitted. A confirmation message is not displayed. Email to support is not generated.

Browser (type and version):

Chrome (10.1)

Version / Timestamp:

Version 3.573 / Aug 23, 2007 8:53AM PST

Remember that you will want to modify the bug templates to suit the needs of your team and projects. When it comes to bugs, there is no such thing as too much information. The goal is to make sure that you have given all the information needed in a structured and repeatable way.