lihaoquan / pe

0 stars 0 forks source link

UG insufficient instructions for starting application #12

Open lihaoquan opened 3 months ago

lihaoquan commented 3 months ago

On page 33 of the DG, the following instructions are stated: image.png

However, similar to issue #11, it is missing a step to ask the user to check their Java version, to make sure that it is 11. Adding this may help the user to avoid hitting obstacles when trying to launch the application.

nus-se-bot commented 3 months ago

Team's Response

This issue here is on the java version checking step being omitted from our instructions to launch TAPro, resulting in obstacles for the user in launching TAPro.

However, that FAQ question scope was to resolve the issue of clicking on the JAR file not working, rather than checking the Java Version, so resolving the issue checking if the Java version was correct could be omitted here, rather than repeated, as having unnecessary repetitions could be raised as a documentation bug. Adding that step may also be redundant, as if the application does launch, the next thing that a reader would do would be to check their java version.

We believe that sufficient information has been provided in the other sections of our User Guide.

image.png

image.png

A typical user would start from reading the Quick start before the FAQ, so would know that their Java version should be correct to launch TAPro.

Therefore, we reject this bug as a reader would implicitly know that Java 11 is used, without needing to explicitly state in in the steps.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]