How to turn debugging notes into a reproducible bug report
A good bug report lets another person understand the problem and attempt to reproduce it. Organizing notes helps separate the evidence from theories formed during debugging.
Start with the right material.
- What you provide
- user-provided reproduction notes plus current-page observations.
- The intended result
- Save a structured issue with actual evidence and unresolved reproduction details.
How the workflow works.
Record environment, reproduction steps, expected behavior, actual behavior and supplied logs or references. Keep uncertain observations marked and preserve exact error text where it matters.
What to check in the result.
Check that another person has enough information to try the scenario. Missing versions or steps should remain open questions, and an untested hypothesis should not be labeled the root cause.
Preview the Markdown to check headings, lists and links as well as the words. Keep source references with the document so a reviewer can trace important statements back to the material you supplied.
Learn from the worked example.
The downloadable Markdown example shows one possible organization of the result. Read it alongside the source example and notice which statements are recorded facts, proposed wording or questions still needing an answer.
The supplied example is illustrative. It is not a recorded run on your data.
Download the example ↓Use it with your own material.
- Open the source you want to work with and activate WebAct on that tab.
- Copy the task from the hero, add any required fields or preferences, and review the proposed actions.
- Compare the first result with your source. Ask for a specific correction or refinement where needed.