Bug Notes Prompt Formatter
Formats scattered bug observations — logs, guesses, reproduction steps, expected vs actual — into a structured debugging prompt.
Overview
Bug notes are written in the moment: partial observations, half-confirmed guesses, log snippets, and environment details all jumbled together. This formatter doesn't investigate the bug — it organises your notes into a structured debugging prompt so an AI assistant can reason from evidence instead of filling in gaps with plausible guesses.
Workflow
-
Collect what you have
Paste your bug notes as-is: logs, observations, guesses, and reproduction steps in whatever order you have them.
-
Open in Prompt Formatter
The formatter classifies each note by type — task, constraint, or output expectation — and groups them into a structured debugging prompt.
-
Check the constraints section
Suspected causes and guesses tend to land in the Constraints section. Review them — if something is confirmed, make that explicit in your notes before reformatting.
-
Use with your debugging assistant
Paste the structured prompt with any relevant code. Structured bug reports produce more specific root cause analysis.
Why This Works
- Separating observed facts from hypotheses prevents the AI from treating a guess as a confirmed cause and skipping the diagnostic step
- Explicit expected vs actual behavior is the most signal-dense part of a bug report — making it a top-level section ensures it gets read first
- Preserving log lines and error messages verbatim prevents the formatter from accidentally paraphrasing away the specific token that identifies the root cause
Best for
- Bug reports written under time pressure where structure was secondary to speed
- Notes that mix confirmed observations with unconfirmed guesses
- Bugs where reproduction steps exist but are scattered across the notes
Not for
- Bugs with no reproduction steps and only a vague symptom — more investigation is needed first
- Production incidents that require live triage — structure the notes after the incident, not during
Use cases
- Formatting Slack notes from a production incident into a structured debugging prompt
- Cleaning up a hasty bug report before escalating it to a senior engineer or AI assistant
- Organising your own investigation notes before asking an AI to help find the root cause
- Preparing a bug report that can be used both as a prompt and as a ticket description