What is a bug report?
A bug report is a message that describes software behaving in a way its maker did not intend. A reproducible one lists the steps, the expected result, the actual result, the page, the browser and how often it happens, so someone else can see the same failure.
By Rafael Thayto 路 Published 路 Last updated
What is a bug report?
A bug report is a message that describes software behaving in a way its maker did not intend. It says what the person did, what they expected to happen, and what actually happened. A good bug report lets someone else see the same failure on their own screen. That test separates a useful report from a complaint.
Bug reports are one of the three common kinds of product feedback, alongside feature requests and praise. They tend to be the most urgent, because a broken step stops a customer from finishing their work. They are also often the quickest to fix, once someone can reproduce them.
Which fields make a bug report reproducible?
Reproducibility depends on a short set of fields. Ask for them in this order, because each one narrows the search:
- Steps. The exact actions, in order, starting from a known page. "Open the invoice list, click Export, choose CSV" is far more useful than "export is broken."
- Expected result. What the person thought would happen, in their own words.
- Actual result. What happened instead, including any error message, copied word for word.
- Where. The page address or the name of the screen inside the product.
- Browser and device. The browser name and version, and whether the person used a phone, a tablet or a laptop.
- Frequency. Every time, sometimes, or only once. A bug that happens every time is much easier to fix.
When one of these is missing, the report still has value, but it becomes a question waiting to be asked. Triage should mark it as needing more detail rather than guessing at the missing part.
What context should you capture automatically?
People rarely remember the browser version or the exact address of the page where something broke. Capture that context for them. The widget in Escuta Produto saves the page URL and the browser user agent with each message, so a bug sent from the widget already includes the two fields that are hardest to recall. The server adds the country as well.
If you identify the signed-in user, the widget can carry their email, name and ID, along with any other keys you pass as metadata. Metadata is stored as JSON up to 4 KB, so you can add the app version, the plan the account is on, or the feature flag that was active. A report with the version attached is far easier to match to a release.
Escuta Produto does not capture screenshots or session replay. For bugs, that means you still ask the customer for the exact error text and a plain description of what they see. The type buttons in the form let the sender mark the message as a bug from the start, so it lands in the bug filter without anyone sorting it by hand.
How do you ask for missing steps without frustrating the customer?
Keep the follow-up short and specific. Thank the person for the report, name the one thing you need, and make the answer easy to give. "Which button did you click last, and did an error appear?" is easier to answer than "Can you provide more details?"
Give a reasonable window for the reply. If the customer does not respond, close the item with a note saying what you asked and when, so the record shows you tried. The guide on following up on bug reports covers timing in more depth. Before you ask anything, check whether you already have the fields listed above, because asking for something you have already received is the fastest way to lose a reporter.
How is a bug report different from a support ticket?
A support ticket is usually a person asking for help with their own situation: an account, a payment, a setting they cannot find. A bug report describes a defect that would affect anyone who follows the same steps. The two often overlap, and a support conversation regularly reveals a real bug, but they need different outcomes. A ticket is solved for one person. A bug report is fixed for everyone who hits it.
Keep the two apart in your head even when they arrive in the same inbox. If a report turns out to be a configuration mistake, close it with a note and answer the customer directly.
Collecting bug reports in Escuta Produto with fewer follow-ups
Escuta Produto keeps bugs in the same inbox as ideas and praise, with a type filter and a status on every item. Place the widget in your product so people can report problems where they happen, or link the hosted page at /f/your-product-slug for people who prefer a form outside the app. Developers who build their own forms can use the REST API, which needs only the public product key and a message of at least two characters, and accepts a kind field so the item is typed as a bug from the start.
In the inbox, filter by bug and new, open each report, and read the saved page URL and browser before you ask anything. Record your reproduction steps in an internal note, then move the status to planned or in progress. Escuta Produto has no issue tracker integration, so copy the reproduction into your own tracker by hand. The widget documentation and the API documentation list each field. For the routine that orders bugs, read how to triage customer feedback.
Frequently asked questions
What is a bug report in one sentence?
A bug report is a message that describes software behaving in a way its maker did not intend, with enough detail, such as steps and the actual result, for someone else to see the same failure.
What fields should a bug report include?
Include the steps to reproduce, the expected result, the actual result, the page or screen, the browser and device, and how often the problem happens. Error text copied exactly is especially valuable.
Should a bug report include a screenshot?
A screenshot helps when it is available, but many products cannot capture one. In that case, ask the customer for the exact error text and a short description of what they saw instead.
Related
- What is in-app feedback?In-app feedback is a form inside your product that sends bugs, ideas and praise to your team with the page and user context attached. Here is how it works.
- What is a feedback widget?A feedback widget is a small script that adds a feedback button and form to your site or app. Learn its three parts, the main widget types and setup basics.
- What is feedback triage?Feedback triage is the regular step where each customer message gets one decision: act, plan, close or ask. Learn the statuses and a sensible cadence.
- Bug report vs feature request: what's the difference?A bug report says the product fails its promise. A feature request asks for something new. Clear tests for each, the gray areas, and why the label matters.