Bug / Defect Report
One defect written so that someone else can reproduce and fix it: where it happens, numbered steps, expected against actual, severity and priority, attachments and a status log. Works for any product and any tracker.
Free. Fill in, print, save as PDF or download as Word without an account. Saving to your account needs a free account.
Country versions
- International
A template, not advice.
Read more
What it is
A bug report is a message from the person who saw a problem to the person who has to fix it. Its one job is to let someone who was not there make the problem happen again. A report that says "the invoice page is broken" costs the developer an hour of questions; a report that names the version, the steps, what should have happened and what did happen can often be fixed the same day.
This form is built around that. It asks for a clear title, where the problem happens (environment, version, device), the steps to reproduce in numbered order, the expected and the actual result, how serious it is (severity) and how soon it should be fixed (priority), the files that show it and where to find them, and a log of what has happened to the report. The fields are plain, so you can copy them into any tracker, and the form works the same for a web page, a mobile app, a service or a game. There is one international version. The report is a working document, not legal advice.
When to use it
- You find a problem while testing or using a product and need to hand it over properly.
- A customer or colleague describes a problem and you want it written down in a form developers can use.
- You have no tracker, or the tracker is not available when the problem occurs.
- You need a printed or Word record of a defect for a test report, a supplier or a warranty discussion.
How to fill it in
- Write a one-line title that says what goes wrong and where.
- Fill in where it happens: environment, version or build, operating system, browser or app, device.
- List the steps in order, one action per row, starting from a known state such as a fresh login.
- Write what you expected and what actually happened; add a workaround if you know one, and who is affected.
- Rate severity and priority, say how often it happens and list screenshots, logs or recordings with where to find them. Remove passwords and personal data first.
- Keep the status log up to date as the report is triaged, fixed and verified.
Common mistakes
- A title like "does not work". Say what, where and under which condition.
- Steps that skip the starting state. "Click Save" means little without knowing which data was open.
- Putting several problems into one report. One defect per report is easier to assign, fix and verify.
- Rating severity by how annoyed you are. Rate by effect: data loss or no workaround makes it severe.
- Attaching logs or screenshots that show passwords, keys or personal data.
Steps at a glance
- Fill in
- Check the preview
- Save as PDF, Word or Excel
Country versions
Pick the country you need. Each version uses the wording and layout commonly found there; a version marked “check with local advice” should be read by someone who knows the local rules before it is used.
- International (XX): Written in English, Korean, Japanese, German
Designs
The same form in several designs. The fields and the wording stay the same; only the look changes.
- Boxed form
- Ledger
- Compact
- Banner
- Warm
- Plain (black and white)
- Modern
- Formal
- Side band
- Classic
- Minimal
- Executive
Your details fill it in
Fields that ask for your name, address or company details are filled from My details, so you do not type them again; you can still change any field for one form. Signed in, your details stay in your account; otherwise they stay in this browser only. A passport, identity or social security number is never saved.
Questions
- What is the difference between severity and priority?
- Severity is how serious the effect of the defect is; priority is how soon it should be fixed. A typo on the home page is trivial in severity but may be urgent before a launch. The reporter usually sets severity, and the team sets priority when it triages the report.
- How many steps should I write?
- As many as someone needs to repeat the problem, and no more. Start from a state anyone can reach, and keep each step to one action. If a step needs special data, name it.
- What if I cannot reproduce it every time?
- Report it anyway. Choose "Sometimes", "Happened once" or "Could not reproduce", write what you did just before, and attach any log. Intermittent faults are hard to catch, but a report with these details helps whoever sees it next.
- Is the form tied to a particular tracker?
- No. The fields are plain, so you can copy them into whichever tracker your team uses, or send the printed page or the Word file when there is none.
- What should I do about a security problem?
- Choose "Security concern". A note then reminds you not to post the report publicly and to leave out secrets. Send it straight to the person responsible for security instead of a shared tracker.
- Is this form legal, tax or accounting advice?
- No. It is a template: it gives you the usual structure and wording, not advice. Rules differ by country and case, so have someone qualified read anything that matters before you sign, send or file it.
- Which countries and designs does it come in?
- It comes in 1 country versions: International. 12 designs.
A form is a template, not legal, tax or accounting advice. Rules differ by country and case.