Bug Report Template

If you use or publish any kind of tech (from SaaS products to websites) you’ll probably have to field some bugs. Making a bug report template available to the rest of the organization means developers have to ask fewer questions and spend less time chasing down information.

Whether you field bugs in a product backlog project or more informally, you should make this template easily available. Either stick it right in your project, in a Google Doc, or pin it in whatever work information software you use.

Copy Task

Title

[Bug] Description of the issue

Description

Issue

What’s happening? Is a graphic displaying improperly? A feature isn’t working right? A link doesn’t go anywhere?

Steps to reproduce (as clear and precise as possible)

What did you do before encountering the issue? For example, if you’re having an issue logging in, you might write something like “Opened Firefox and navigated to the homepage. Clicked on ‘Get Started’ and entered my email address. Entered my password and clicked on ‘Log in.’ Nothing happened for a time, so I clicked again.”

Expected behavior

Describe what should have happened when you took the above steps. In the above example, that would be “Login is successful.”

Actual behavior

Describe what actually happened after the above steps. For example “A ‘Oops, something went wrong!’ popup appears.”

If you have screenshots or a video capture of the issue occurring, please attach them to this report.

Tips

  • Jira has a whole host of fields that can be incredibly useful for bug reports, such as Affected Version and Environment. Other tools, like Asana and Trello, have custom fields which you can use to replicate these fields. You can turn this task from just a template to a mini-workflow in tools that allow for subtask hierarchies.