Improve a Bug Report for Developers
Transform raw bug notes, logs, and observations into a well-structured bug report with a precise title, clear reproduction steps, expected vs actual behaviour, severity/priority reasoning, and an evidence checklist.
You are a senior QA engineer who writes bug reports that developers can act on immediately. Improve the raw notes below into a professional bug report. IMPORTANT: Do not invent any facts, error messages, step details, or behaviour descriptions not present in the notes below. If information is missing, mark that field as "[NEEDS CLARIFICATION]" rather than guessing. Raw bug notes: {{RAW_NOTES}} Environment: {{ENVIRONMENT}} Logs or error messages (paste relevant excerpts only — no credentials, tokens, or PII): {{LOGS}} Output the improved bug report in this exact format: **Title:** [One sentence: component + what went wrong + observable impact — max 100 characters] **Environment:** [OS, browser/app version, relevant feature flags] **Severity:** [Critical / High / Medium / Low] — [one sentence explaining why this severity is appropriate based on user impact and frequency] **Priority:** [P1 / P2 / P3 / P4] — [one sentence explaining the business urgency] **Steps to Reproduce:** 1. [Precise, numbered steps — each step is one action] **Expected Result:** [What should happen, based on stated requirements or product behaviour] **Actual Result:** [What actually happened — exact error message if available] **Evidence Checklist:** - [ ] Screenshot or screen recording attached - [ ] Browser/device console log attached (sanitised — no credentials or PII) - [ ] Network request/response captured (if relevant) - [ ] Steps confirmed reproducible by a second person **Additional Context:** [Relevant logs, frequency of occurrence, regression notes — sanitised] **[NEEDS CLARIFICATION] items:** [List every field left blank or uncertain that a developer will ask about]
{{RAW_NOTES}}requiredYour raw bug notes, observations, or initial report draft — as rough as needed
e.g. clicking save on the profile page sometimes doesnt work. tried a few times. seems to happen when theres a special char in the bio field. got a 500 error in console once
{{ENVIRONMENT}}requiredOS, browser, app version, and any relevant environment details
e.g. macOS 14.4, Chrome 124, staging env, feature flag profile-v2 enabled
{{LOGS}}Relevant log excerpts, error messages, or stack traces — no credentials, tokens, or customer data
e.g. POST /api/profile 500 Internal Server Error TypeError: Cannot read properties of undefined (reading 'sanitize')
- Read the [NEEDS CLARIFICATION] section — every open item must be answered before filing the ticket.
- Verify no credentials, tokens, customer data, or PII are in the logs or additional context fields.
- Check the Severity and Priority reasoning is accurate for your team's conventions — AI assignments are a starting point.
- Confirm reproduction steps can be followed by someone with no prior knowledge of the issue.
- Validate the Expected Result is backed by requirements or documented behaviour — not the AI's assumption of what 'should' happen.
- Attach actual evidence (screenshots, recordings, sanitised logs) — the Evidence Checklist is a reminder, not a substitute.
- Have a developer do a 30-second read of the report to confirm they can act on it without questions.
AI output requires human review before use. These checks are your responsibility.
Example output
// NOTE: This is an illustrative draft based on the raw notes above. Every [NEEDS CLARIFICATION] item must be resolved before filing the ticket. **Title:** Profile save fails with 500 error when bio contains special characters **Environment:** macOS 14.4, Chrome 124, staging, feature flag: profile-v2 enabled **Severity:** High — save failures lose user data silently; affects any user who uses special characters in their bio **Priority:** P2 — staging-confirmed data-loss path; not blocking all users but high user impact **Steps to Reproduce:** 1. Log in as a standard user 2. Navigate to Profile > Edit 3. Enter a bio containing a special character (e.g. an ampersand & or angle bracket <) 4. Click Save **Expected Result:** Profile saves successfully; updated bio is displayed on the profile page **Actual Result:** Save button appears to process but profile is not saved. Browser console shows: POST /api/profile 500 Internal Server Error **Evidence Checklist:** - [ ] Screenshot or screen recording attached - [ ] Console log attached (sanitised) - [ ] Network request/response captured - [ ] Steps confirmed reproducible by a second person **[NEEDS CLARIFICATION]:** - Which specific special characters trigger the issue? (& confirmed; others untested) - Is this reproducible 100% of the time or intermittent? - Does the 500 appear consistently or only on first attempt?
- Generate a minimal repro script in Playwright that captures the exact steps above.
- Suggest what the root cause might be given the TypeError in the logs, so the developer has a head start.
- Write the acceptance criteria for the fix so the developer knows when this bug is resolved.
- Generate a regression test case to prevent this defect from re-appearing after the fix.
- CRITICAL: The AI is explicitly instructed not to invent facts, but it may still fill in plausible-sounding details if the raw notes are vague. Review every sentence against the original notes.
- Severity and Priority assignments are estimates — they must be reviewed against your team's severity matrix.
- The AI cannot confirm reproduction steps — steps generated from vague notes may not actually reproduce the issue.
- Expected Result may be wrong if the AI infers correct behaviour rather than reading it from a spec.
- Sanitised logs must be reviewed by a human before sharing — the AI cannot detect sensitive data it wasn't shown.