search

woojiahao / pe

1 stars 0 forks source link

Incorrect launch instructions in "Instructions for manual testing" in DG #2

Open woojiahao opened 10 months ago

woojiahao commented 10 months ago

The DG contains instructions to "Double-click the jar file" with an expected outcome for it to show the GUI with a set of sample contacts but doing so on a Mac machine results in the following error:

Screenshot 2023-11-17 at 16.10.54.png

nus-se-script commented 10 months ago

Team's Response

Thank you for pointing this out.

This problem has already been addressed in the FAQ, where we mentioned that if the file does not open upon double clicking then use the java -jar command to open it.

Screenshot 2023-11-20 at 2.08.42 AM.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The FAQ is only available in the UG, not the DG. As a result, developers who are attempting to follow the manual instructions for testing and are only referencing the DG may face this issue and not intuitively look to a completely different document to find a potential remedy for this issue.

Just because this has been covered in the UG, doesn't mean it is available knowledge to those using and following the DG. While it is mentioned that the section should not duplicate information from the UG, I believe launching the JAR is a crucial first step and more can certainly be done to help readers debug this issue without having to jump between documentations. Doing so only confuses the user and makes it harder for them to navigate the application (since they cannot start it and may not know where to find the FAQ)