How to submit the perfect bug report

“Our website is broken! Please fix it right away, we’re losing business!”

website bug report

Every Dev or Designer has had a client ask them to set everything aside to urgently fix their ‘broken website’.

“It’s just a small change” they cry as they email with details to fix the problem. The real problem for you though isn’t in making the changes, it’s in working out exactly what the issue is in the first place. Usually by exchanging many emails and phone calls.

Get perfect bug report… every time.

The phrase “Give a man a fish and you feed him for a day; teach a man to fish and you feed him for a lifetime” rings true to this scenario.

Either you can spend time toiling through back and forth emails trying to replicate an issue, and have to do so every time. Or you can teach your client to write perfect, contextual (and actionable) bug reports, the way you want them written.

Next time you find yourself in this situation, use this handy bug report template. It doesn’t work for every situation but at least it will get your clients and PMs thinking about how they can better help you to resolve issues.

10 steps to writing a better bug report –

1 – What is the exact URL of the page?

 2 – Can you take a screenshot of the issue?

taking a screenshot

3 – What do you expect to happen/ it to look like?

button changing colour

 4 – What browser and operating system are you using?

browsers and operating system icons

 5 – Are you getting an error code? If so what is it?

error message

 6 – What steps prior to getting the error did you take?

what were you doing prior

 7 – Can you replicate the issue?

cloned sheep

 8 – What have you tried to do to fix it so far?

bug reporting steps

 9 – How urgent is it? Can you set a priority?

bug reporting urgency

 10 – Are there any supporting documents you can provide?

pen and notepad

Help us, help you. With a bug reporting template:

Feel free to download this handy dandy bug reporting template example to pass it on to your clients:

Grab the BugHerd Bug Reporting Template here

Remember: the best bug and issue reports are ones with exact steps to replicate the issue and a screenshot is worth 100 words.

About Chanie - Chanie has been working to grow startups for more than 8 years. As one of the first hires at BugHerd, Chanie was instrumental in the companies' early success. Once the Head of Marketing for Australia's largest startup accelerator (BlueChilli), Chanie mentors and guides many small businesses through growth marketing strategy, including being back at BugHerd!

Comments are closed here.