The Friday Deploy
The plain English newsletter for people who run the business, not the tech stack. No jargon. Every Friday.
Help Me Help You: How to Write a Bug Report That Saves You Money
There is a line in Jerry Maguire that has nothing to do with software and everything to do with software.
“Help me help you.”
When something breaks on your website or app, the instinct is to fire off a message as fast as possible. “The checkout isn’t working.” “Something is wrong with the login page.” “A customer just called and said they can’t place an order.”
That message feels like action. It is not action. It is the start of an investigation your developer now has to run before any fixing can begin.
Every hour spent reproducing what you already witnessed is an hour billed against your retainer and not applied to the fix.
This post is about how to change that.
A vague bug report is not a task. It is a puzzle.
When a developer receives “the checkout isn’t working,” here is what they do not know:
- Which step in the checkout fails
- What the user sees when it fails (an error message, a blank screen, a redirect, nothing)
- Whether it happens on every device or just some
- Whether it has happened once or dozens of times
- What the user was doing immediately before it happened
They have to find all of that out before they can write a single line of code. In a worst case, they cannot reproduce the issue at all, which means the back-and-forth begins: questions, responses, more questions. The clock runs the whole time.
A good bug report hands the developer a solvable problem. A vague one hands them a scavenger hunt.
Five things every bug report needs
1. What you expected to happen
This sounds obvious, but it matters. “I expected to land on the order confirmation page” is more useful than silence, because it tells the developer exactly where the flow broke.
2. What actually happened
Be specific. “It showed a white page with an error” is more useful than “it didn’t work.” If there is an error message on screen, copy it down word for word. That message is often the fastest path to the cause.
3. Steps to reproduce
This is the most valuable thing you can provide. Number them. Be exact.
Went to the product page for [item name]Clicked Add to CartClicked View CartClicked Proceed to CheckoutFilled in name and email, clicked ContinuePage went blank
A developer who can follow those steps and reproduce the same result can fix the bug. A developer who cannot reproduce it has to keep guessing.
4. Environment
Device, browser, and operating system. This combination matters more than most people realise. A bug that only appears on iPhone Safari and not Chrome on desktop is a different bug to one that appears everywhere. Knowing this upfront can cut investigation time significantly.
If the issue is account-specific, note that too. “This happened when I was logged in as an admin” versus “a customer reported this on their regular account” points in completely different directions.
5. Supporting evidence
A screenshot is good. A screen recording is better. If your browser shows an error in red text, photograph that. And include the URL of the page where the issue occurred; the full address bar, not a cropped screenshot of just the content. The number of times a perfectly useful screenshot arrives with the address bar carefully removed is a number no one should have to think about.
You do not need to understand what any of this means. You just need to capture it. Your developer will know what to look for.
One more thing: frequency and pattern
If you can answer these two questions, add them:
- Has this happened more than once?
- Is it happening for one person or multiple people?
A bug that one customer reported once is a different priority to a bug that three customers reported in the same afternoon. Pattern tells the developer how urgent to treat it and whether there is a systemic cause worth looking for.
A template you can copy right now
Keep this somewhere accessible. Share it with anyone on your team who might need to report an issue.
Bug Report
What I expected to happen: [Describe the expected outcome]
What actually happened: [Describe what occurred, including any error messages word for word]
Steps to reproduce:
*Device / Browser / OS: *[e.g. iPhone 15, Safari, iOS 17]
*Is this account-specific? *[e.g. happened as admin / happened as a regular customer account]
*How often is this happening? *[e.g. happened once / reported by three different customers today]
Screenshots or recordings: [Attach or link]
The point
Your developer is hired to fix problems. They are good at it. But fixing requires finding first, and finding takes time that comes out of your budget.
A good bug report does not require technical knowledge. It just requires observation and the habit of writing down what you saw before you send the message.
Help them help you.
Read more Technical Translation
Bug Reports, Digital Product Management, Team Communication, Technical Operations, Working with Developers
Previous NextThe Friday Deploy
The plain English newsletter for people who run the business, not the tech stack. No jargon. Every Friday.