Skip to content

Instantly share code, notes, and snippets.

@scoobster17
Created September 13, 2017 16:29
Show Gist options
  • Save scoobster17/cbca8a338448e4a1024ebbcec93fdab7 to your computer and use it in GitHub Desktop.
Save scoobster17/cbca8a338448e4a1024ebbcec93fdab7 to your computer and use it in GitHub Desktop.
Website defect template

Defect template

Here is a defect template which aims to encourage ALL relevant information being provided to cut down debugging time.

Template (blank)

SUMMARY:

DEVICE(S):

OPERATING SYSTEM:

BROWSER(S):

FULL URL:

PRODUCT(S):

USER INFORMATION:

STEPS TO REPRODUCE:

EXPECTED RESULT:

ACTUAL RESULT:

DATE OCCURRED:

TIME OCCURRED:

PLEASE INCLUDE SCREENSHOTS OF THE ISSUE. PLEASE USE A BROWSER EXTENSION LIKE FIRESHOT FOR CHROME TO CAPTURE THE ENTIRE PAGE IF POSSIBLE

Template (with examples)

I have also filled out the details as an example of what I might expect, to give an example with notes / comments in red: PLEASE NOTE THIS IS A MADE UP DEFECT AND DOES NOT ACTUALLY OCCUR

SUMMARY:

My orders not listed in my account

DEVICE(S):

Desktop another example may be Samsung Galaxy S6

OPERATING SYSTEM:

Windows 7 other examples may be: Mac OSX El Capitan / iOS10

BROWSER(S):

Chrome, Firefox, IE11, IE10

ENVIRONMENT:

Production

FULL URL:

http://www.example.com/account/my-orders (NOT JUST www.example.com, we need the FULL URL to the page with the problem)

PRODUCT(S):

123456 pva glue, 234567 red biro pens (list products used when finding the bug, e.g. SKUs and names to see visibly on site)

USER CREDENTIALS:

[email protected] / password1

STEPS TO REPRODUCE: (from scratch, to avoid confusion)

  1. Navigate to http://www.example.com/
  2. Sign in with credentials above
  3. Click on my account link in header
  4. Click on the my orders link

EXPECTED RESULT:

On the orders page seen, all orders placed and their details are displayed in date/time order with most recent first

ACTUAL RESULT:

No orders listed on the orders page

DATE OCCURRED:

21/9/2016

TIME OCCURRED:

13:01 (sometimes helpful for BE developers to check logs / check which build was deployed at this time)

PLEASE INCLUDE SCREENSHOTS OF THE ISSUE. PLEASE USE A BROWSER EXTENSION LIKE FIRESHOT FOR CHROME TO CAPTURE THE ENTIRE PAGE IF POSSIBLE

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment