nichee / pe

0 stars 0 forks source link

DG states app can be opened by double clicking #18

Open nichee opened 4 months ago

nichee commented 4 months ago

image.png

image.png

image.png

I could not open the jar file. I am shown options to open the jar with, and both cause the error above. The documentation does not reflect the java -jar command required to test the file

nus-se-script commented 4 months ago

Team's Response

Thanks for raising this - we understand that this is an issue however we believe this is an issue with our documentation rather than the app itself - and it could be corrected with a one line replacement in our DG. In our UG we also provided alternative ways to launch the app (including the cli way you mentioned) so a user would be able to figure out how to launch the app successfully albeit through a more cumbersome process.

This issue is a duplicate of #747.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Incorrect DG instructions for Manual Testing

The description says to double click the jar file, but double clickign gives an exception.

image.png


[original: nus-cs2103-AY2324S2/pe-interim#597] [original labels: type.DocumentationBug severity.High]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Thanks for raising this - we understand that this is an issue however we believe this is an issue with our documentation rather than the app itself - and it could be corrected with a one line replacement in our DG. In our UG we also provided alternative ways to launch the app (including the cli way you mentioned) so a user would be able to figure out how to launch the app successfully albeit through a more cumbersome process.

A high severeity bug usually applies to catastrophic issues that severely hamper the usage of the app. We feel that this is not what is happening in our case and as such we have requested to lower severity.

Please find below a screenshot of our UG that describes the CLI alternative of opening MediCLI:

Screenshot 2024-04-20 at 3.08.12 PM.png

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** ![image.png](https://raw.githubusercontent.com/nichee/pe/main/files/bf4d690d-c44b-486f-b965-22f74e4c7121.png) Frequency of problem The double-click to open is the only method listed in the DG, as well as the first method in the UG, so it would be natural for it to be the first way a user or developer to try to open the file. Therefore I do not think that it can be justified that this is a "very rare situation", in fact a majority of users would not only prefer the simpler method of opening the file, but also the first one listed in the UG, and the only one listed in the DG. Impact of problem "so a user would be able to figure out how to launch the app successfully albeit through a more cumbersome process." is stated in the Developer response. They describe the possible solution as "more cumbersome", which I feel better fits the "severity.Medium" description of "Occasional inconvenience" as opposed to the "severity.low" description of "minor inconvenience"