Belowline.
← Guides
Guide

Write a reusable bug report.

Demo · A clear template for steps, expected behaviour, actual behaviour and useful technical context.

1 min read
Placeholder for Write a reusable bug report

Demo content: original sample text for testing the website layout. Replace or edit before using it as a finished publication.

Describe the problem

Give your bug report template a specific title. “Save button returns an error after changing a title” is more useful than “The website is broken.” State what you were trying to do before the failure.

List reproducible steps

Number each action and use a small sample. Record what you expected and what happened instead. Include the browser and operating system if relevant, but remove passwords, session cookies and private information from logs.

Check the report

Repeat the steps once if it is safe to do so. Mention whether the problem happens every time or only sometimes. Include the exact visible error message rather than replacing it with a guess about its cause.

Comments

No published comments yet.

Leave a comment

Human verification
Comments appear after 12 hours. Editors can edit or delete them.