Development
Bug report template in Markdown
A bug gets fixed faster when someone else can reproduce it on the first attempt. This template gives you a fixed order for the facts: a one-sentence summary, the environment, numbered steps, what you expected, what happened, and the evidence. Fill it in and export a PDF.
Open this template in the editor- Category
- Development
- Default style
- Technical
When to use it
Use it when an issue has to travel outside your tracker: to a vendor, a client, a support desk or a manager who wants a record on file. The reader is usually a developer or tester who was not there when it broke, so every section answers a question they would otherwise have to ask you.
What is inside
- A header with fill-in fields for the project, your name and the date, plus a severity line.
- An environment table for app version, browser and operating system, and device type.
- Numbered steps to reproduce, expected and actual behavior, evidence and a workaround section.
Tips for a better document
- Copy the exact error text instead of describing it. Paste log excerpts into a code block so they keep their spacing, and remove credentials and personal data first.
- Cut the steps down to the minimum input that still triggers the problem. The template opens in the Technical style, which keeps tables and code easy to scan.
Template preview
Bug report: Project or topic
Reported by: Your name · Date: Date
Severity: Low / Medium / High
Summary
Describe the issue in one sentence, including the action that triggers it.
Environment
| Detail | Value |
|---|---|
| App version | Add version |
| Browser / OS | Add details |
| Device | Desktop / Mobile |
Steps to reproduce
- Open the relevant page.
- Enter the minimum input needed.
- Perform the action.
Expected behavior
Describe what should happen.
Actual behavior
Describe what happens, including exact error text.
Evidence
Add a screenshot or sanitized log excerpt. Remove credentials and personal data.
Workaround
Record a temporary workaround if one exists.
Fill-in fields such as your name and the date are replaced when you open the template in the editor.