geraldkoh4 / pe

0 stars 0 forks source link

For the UG, I think a diagram is necessary. #16

Open geraldkoh4 opened 1 year ago

geraldkoh4 commented 1 year ago

image.png

image.png

For a first time user who does not know anything about setting up Java, when there is a lack of diagram, they might not be able to set up the environment to run your application. I choose the medium severity as the UG which is meant to be read by first time users with no experience, can still use other resources to set up java and run your program. But most first time users reading the user guide will face this issue and this issue will be inconvenient for them.

soc-pe-bot commented 1 year ago

Team's Response

We do not understand what diagram is the user referring to.

Items for the Tester to Verify

:question: Issue response

Team chose [response.IssueUnclear]

Reason for disagreement: image.png

I believe that diagram can be misinterpreted here. But there is enough context and explanation to understand there should be more images, steps or labelling to ensure that a new user can install Java properly. A simple reference to AB3 should be clear (which should have been done when writing up their documentation).


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** ![image.png](https://raw.githubusercontent.com/geraldkoh4/pe/main/files/6ca1863d-a449-428a-8ede-ec3c615cdfd9.png) Severity is medium as most of your users are new users. New users cannot be assumed to know how to install java. It is the entire purpose of the UG to ensure that the application can be used by them. It is not rare and not a minor inconvenience. It is in between medium and high, and I chose medium as it was more representative.