Skip to content

Instantly share code, notes, and snippets.

@ezl
Last active September 22, 2020 04:17
Show Gist options
  • Save ezl/d8922fb6a9722101832c to your computer and use it in GitHub Desktop.
Save ezl/d8922fb6a9722101832c to your computer and use it in GitHub Desktop.
Anatomy Of A Well Written Ticket

##How to specify a ticket or repair request:##

  1. identify problem -- use screenshots, copy/paste screen text, etc
  2. describe how to reproduce the error -- detailed steps that a toddler could follow to replicate the bug / behavior
  3. identify correct behavior, include images, screen shots, descriptions, whatever, including, if necessary, what testable behavior would indicate success in fixing this problem.
  4. state the impact on the business and the customer, the reason for making the change -- basically, make the case for devoting time/effort/money to fixiing the issue.
  5. recommendation for repair urgency and/or informed economic analysis

##Example (reported by Theora):##

###1. Problem Description### All users see that the fee is $4.95. Some users do not actually pay this amount for a withdrawal.

###2. How To Reproduce the Problem### Sign in as foo@bar.com and go to my payments page(https://rentapplication.net/users/payments/) . See https://imgur.com/Jtq8T7C which is showing the wrong amount.

###3. Correct Behavior### Page will query user info to determine and display the correct withdrawal fee. If you look up this user in the admin, you'll see that his actual withdrawal fee is $2.95.

###4. Impact### Not many users experiencing this problem right now, but may be an important fix for the future. Impacts 1 in 100 users.

###5. Level of Urgency / Economic Analysis### 2: Not urgent as very few users are affected and it does not impact core site functionality. If easy, knock it out under JFDI/"bugs first" rules. Impact to revenue: zero.

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