Scribd
Upload
4 views6 pages

The Correct Way To Write A Tittle

The document outlines the correct procedures for writing bug reports, emphasizing the importance of clear titles, detailed reproduction steps, actual results, expected results, and the environment used. It also distinguishes between content bugs, functional bugs, and visual bugs, providing examples and guidelines for each type. Additionally, it highlights the necessity of including screenshots and ensuring reports are complete for effective review.

Uploaded by

derrickkamande2020
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
4 views6 pages

The Correct Way To Write A Tittle

The document outlines the correct procedures for writing bug reports, emphasizing the importance of clear titles, detailed reproduction steps, actual results, expected results, and the environment used. It also distinguishes between content bugs, functional bugs, and visual bugs, providing examples and guidelines for each type. Additionally, it highlights the necessity of including screenshots and ensuring reports are complete for effective review.

Uploaded by

derrickkamande2020
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 6

The correct way to write a tittle:

Wrong: Error shown on the cart page


Correct: “checkout” button from the cart page navigate users to an “Error 500”
page

Wrong: The user cannot add a product to the cart


Correct: On the “Batman T-Shirt” page, Users get an “Unexpected Error” message
when attempting to add the item to the cart
URL
Visit the page where the bug appears and copy & paste the URL from your
browser’s URL field into the field URL of the bug report form.
The URL must be a valid one.
Steps to reproduce
Bugs have to be reproducible and they need a detailed step-by-step guide on how
they can be reproduced. Each step should describe a separate action.
The first step must contain an indication to access the URL of the landing page
provided by the customer in the Access section.
Describe the actions from the initial step up to the point when the bug occurs.
What buttons you press
What links you follow
What you enter
Describe the action that you perform that triggers the bug.
Make sure your steps contain the least amount of actions possible to perform.
Exemplary steps
1. Go to http://www.examplewebsite.com
2. Enter any search query in the top-right search bar (e.g. “san Francisco”)
3. Click on “search now” button
4. Scroll down and click on sort by
5. Select the option sort by price high to low
Exemplary BAD steps
1. http://www.examplewebsite.com
2. Observe
3. Search >sort>high to low
4. Observe

ACTUAL RESULT
The actual result is one of the most important fields of a bug report because here
you explain what the problem is and all further details that are needed to
understand the bug.
The actual result must not be the same as the report’s title.
While the title is a summary of the problem, the actual should be a detailed
description of it and should include further details such as scenario information,
examples and results obtained while performing the steps to reproduce the bug.
Exemplary actual result
Wrong: Error shown on the cart page after clicking on the checkout button
Correct: “Error 500 –Internal Server error- sorry something went wrong is shown
to the user after he tries to proceed to the checkout page

Wrong: The user cannot add a product to the cart, an error is shown
Correct: An ‘unexpected Error’ error message appears in the top right corner of the
PDP, and the product is not added to the cart

Expected Result
Describe what you expected to happen after performing your last described step.
As always, detailed are the key. Think about what should have happened if you
had not experienced the bug if everything worked correctly.
Exemplary expected result
Wrong: User can procced to the checkout
Correct: The user should be redirected correctly to the checkout page, where he
should be able to add shipping and payment info and place an order.

Wrong: Product should be added to the cart


Correct: The product “Batman T-shirt” should be successfully added to the cart.
The user should not encounter errors like ‘error 505’ and should be able to check
out any items in their cart.
Used environment
It’s important for us and our customers to know which device you used when you
experienced the bug.
You may only use the devices for testing that are listed in this section.
Furthermore, you should select only one device or browser when you are reporting
the bug, and upload only attachments for it.
If able to reproduce the bug in other devices or browsers, please mention this in
your Actual result
Selecting the correct environment where the bug occurs is a mandatory action.
When you submit your report, please make sure that you select the correct
environment.
Improving your report
You must always submit compete bug reports that are ready to be reviewed.
CONTENT BUGS
Content bugs relate to the actual content of websites or apps: text, labels, pictures,
videos, icons, links, data, etc., hence content bugs are:
 Broken links or image (404s)
 Defective redirections, in general
 Missing text e.g. in an empty tooltip
 Missing content e.g. empty content area
 Missing content e.g. if 4 out of 5 icons have a tooltip, 1 doesn’t
 Missing translations e.g. some buttons on an English website having French
labels
 Some products are missing in search results, but the search function itself
works
 Missing data
Repetitive problems
When a content problem occurs repetitively, it may only be submitted once, even
though each occurrence may have a different URL, link, picture, etc.
This single bug report should state that other URLs, links, pictures, etc., are also
concerned.
Example of repetitive content bugs:
 Some product pictures on product detail pages of a web shop are broken
 Some download links for PDF manuals on product detail pages lead to 404
pages
 Some product descriptions are in a different language than the rest of the
web shop
 Some labels or texts snippets on a website have missing translations
 Information is missing for different items, products, or pages
 Some tooltips don’t contain any information
 Some links that belong to the same group broken
UPGRADE TO FUNCTIONL BUG
As soon as a content bug prevents a functionality, it should be reported as a
functional bug.
When a content bug occurs in a functional component of the product namely
linking problems in the navigation menu, header, footer, or breadcrumb navigation,
such problems are typically low bugs.
Content reports must contain screenshots.
Spelling problems are not content bugs
Staging environments often have dummy texts, or the content is missing.
This is not a bug.

VISUAL BUGS
The customer only needs a single reference to be made aware of the visual
problem.
Examples:
 Some elements show the same graphical problem e.g. texts or images are
larger than their boxes.
 Input fields are not large enough to hold their default texts that are, in turn,
not completely visible
 Teasers unintentionally overlap other elements.

Visual reports must contain screenshots. An additional screencast might be


required if an action causes a visual problem.
Responsive vs. nonresponsive website content: The hidden visual bugs
Responsive bugs might puzzle you about its categorization between content and
visual bugs, issue created by the website’s responsive design.
How to identify
 Look for inconsistent scaling between pages
 Check if the text becomes illegible on your screen size
 Notice if navigation elements become too small to tap
 Watch for horizontal scrolling appearing on some pages but not others
Free Online Responsive Test

You might also like

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy