Make the behaviour easy to find again
An actionable bug report gives another person a clear starting point. It describes a specific observation, explains what was expected and provides enough context to follow the same path.
Name the observed problem
Prefer a title that describes the behaviour and its trigger. “Checkout remains on payment after changing the delivery address” gives a reader more to work with than “Checkout broken.” Keep the observation separate from an unconfirmed explanation of its cause.
Separate expected and observed results
Expected: submitting a valid test order opens confirmation. Observed: the application remains on payment after the delivery address changes. Keeping these statements distinct makes the divergence clear.
Write reproducible steps
- Add an item and open checkout.
- Select a different delivery address.
- Submit with a valid test payment.
- Observe whether confirmation opens.
Include the environment and relevant starting conditions. Add screenshots, recordings or logs when they are actually available and safe to share; do not imply that an attachment exists when it does not.
State the limits
In this illustrative example, confirmation was not reached. Other payment methods, devices and journeys have not been examined. Describe those limits explicitly instead of allowing an incomplete journey to read as a pass.
The report is useful when a teammate can understand the behaviour, investigate it and decide the next step. Clear evidence saves interpretation; it does not require an invented confidence score.
Originally published on the Antidote blog. I work at Antidote.
Top comments (0)