Bug reporting

Product - beSlick

If a bug report is written well, it avoids any confusion or miscommunication. Bugs are fixed quicker. Here's all the information you need to capture when reporting a bug in a software system. Use this template to improve your software development process. 

Use template

Bug reporting

1Description of issue

Importance: Essential

Ensure that this is exactly what the user reported, although bear in mind that the user's description and knowledge of the system may well be different to your own.

Try and avoid including speculations of what might be the problem, unless the user is very, very knowledgeable about the system (i.e. to the same level as the product team!)

Description:

1.1What was the user doing when the issue occurred?

Importance: Optional

A step by step list of what the user was doing is important when trying to replicate the issue.

How to replicate:

1.2What should the expected behaviour be?

Importance: Optional

This can be useful in cases where what the user considers to be a bug is actually how the system works (!)

Expected behaviour:

2Is there a screenshot or video of the issue?

Importance: Optional

Screenshots are very helpful when trying to diagnose the source of an issue. If possible, displaying the browser developer tools while taking the screenshot of the issue allows any error messages to be seen.

Screenshot/video:

3System information

Importance: Optional

Is the user logged in as a specific role (e.g. System Admin)?

System info:

4Browser and operating system

Importance: Optional

What browser and operating system were they using? This website allows you to send information about your browser to someone else: whatsmybrowser.org

Operation system:
Browser:

5Is the issue repeatable?

Importance: Essential

Following the steps given by the user, can you reproduce this on a similar computer set up? What about on a different set up (e.g. browser or user role).

Repeatable?:

6Priority

Importance: Essential

To assess priority of an issue, think about its frequency and impact.
Frequency: how often do users encounter the problem? All users, or some?
Impact: what affect does the issue have? Does it mean a main activity can't be completed?

Issues involving problems with security or data are highly likely to be critical bugs.

Priority:

Try beSlick for free

beSlick embeds processes like these into your organisation, so it runs like clockwork.

Click 'Use template' and request a free trial - we'll help your teams get it right, every time.


Use template