KISS method for bug reporting

It’s essential to keep bug reports as clean and easy to read as possible. At Testlio, we use the KISS method, commonly known as “Keep It Simple Stupid“.

We’re constantly striving to take complicated issues and make them as easy to read and understand as possible. As a tester, you should know that this shouldn’t come at the cost of quality and detail.

Things to keep in mind

The Problem – Keep your eye on the prize, or in this case, the reason you’re writing a bug report in the first place. Make sure your title and description are focused on that problem, and not the less important details.

Length – Detail is appreciated, but leaving a wall of text about an issue makes it harder to follow and understand. Keep your report short, simple, and focused!

Proof – Some bugs only exist on one platform or OS, some can’t be reproduced at all. Make sure to include screenshots, videos, and logs so we can confirm what happened.

Related Issues – Are there other actions that could cause the same problem? Are they relevant to mention in your report?

Creating a bug report with Testlio

The following is our preferred format for a bug report. Here are some guidelines and tips to help you succeed on our platform!

1. Title

[Profile] Uploaded photos are rotated sideways

  • Between the [ ] brackets, first specify what section of the app the bug was found. Be specific!
  • Follow the brackets with a short description of the problem

2. Device Details:

In this section, we’re looking for details about your testing environment. List your device, operating system, app version, browser version, and internet connection, depending on relevance.

3. Steps to Reproduce

List your exact steps to reproduce the issue, and don’t skip any steps!

  • Use the ‘>’ symbol to signal navigating from one step to the next
  • Keep it simple and easy to follow!

What NOT to do
Steps to reproduce:

  1. Open app
  2. Log in with valid credentials
  3. Tap on Settings
  4. On the displayed options select Profile
  5. Tap on Edit in the top right corner
  6. Tap on Profile Image
  7. Select an image saved on phone
  8. Select Upload
  9. Tap on Save Changes

Simplified! (Here’s how to do it)
Steps to reproduce:

  1. Settings > Profile > Edit
  2. Change Profile picture > Save

4. Expected Result

In shorthand, write down what should be happening in this situation

5. Actual Result

Here is where you record the problematic behavior. What’s broken?

6. Attachments

We require at least one attachment with every bug report. Not everything is reproducible on every device or environment, so it’s extremely important to include proof and detailed documentation of how the bug is occurring on your end.

  • Screenshots: Visual bugs that are stationary are often easy to display with a screenshot which highlights the problematic behavior
  • Videos: Many visual bugs happen when switching between screens, or need motion to be understood. When this is the case, screenshots are not sufficient.
    • If you are on iOS 11 and above, try using iPhone’s own screen recorder, you can watch a video on how to do that here. Using another device to record a video may be the easiest option if you are having issues with the software.
    • On Android, we suggest AZ Screen Recorder, you can read more about how to use it here.
  • Logs: Logs allow developers to dig deep into the root of the issue to see exactly what went wrong on your device. Many crashes and errors are not easy to reproduce. Without a crash or console log, your report will not provide much value.

That’s the gist of it! As always, use your best judgment to make reports as clear as possible!