When studying how to create a bug report, start with the question:
What does a bug report need to tell the developer?
An effective bug report should be able to answer the following questions:
- 1. What is the problem?
- 2. Where were you when you found this idea/bug? (Provide a URL)
- 3. What were you expecting to happen?
- 4. What actually happened?
- 5. How can the developer reproduce the problem (to see it for themselves)?
- Is there any data that needs to be provided in order to reproduce the issue?
- 6. Where in the software (which webpage or feature) has the problem appeared?
- 7. What is the environment (browser, device, OS) in which the problem has occurred?
- 8. Is there a workaround?
- 9. A screenshot of the issue will be very helpful. Here's more information about how to take a screenshot
- For example, if you can't log in for some reason, it won't help too much if you post:
"ARGGG!!!! I can't log in. Help!" - Instead, take a look at the questions above. A response that will enable us to help you may sound something like this:
"When I was on the homepage (https://my.park.edu/), I clicked on the 'Login' button. I expected to see a page to log into my.Park.edu; Instead, the page went black. I reloaded the page, tried again, and it happened a second time."
OR
"I was advising student (STUDENT ID#) and tried to print a degree audit for the student through the Advisee Roster and received an error message." [Screenshot of error message]