search

eesung00 / pe

0 stars 0 forks source link

Double Click jar file might cause problem to Mac user #8

Open eesung00 opened 1 year ago

eesung00 commented 1 year ago

image.png

Should inform the user to use java -jar to ensure the opening of the app

nus-se-script commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Incorrect instructions for starting application on macOS

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

Description

The "Getting started" portion of the user guide specifies that to start the app, readers should...

Double-click the file to start the app. A window similar to the one below should appear in a few seconds.

This does not work on macOS, and the app is unable to start, as shown below (security settings by Apple). This is especially problematic for macOS users, since they might not be familiar with how to start the app from the terminal- in the worst and most probable case (since the target audience are not tech-savvy persons assumed to have experience with Terminal; UG says "No other technical knowledge is required."), the app becomes totally unusable.

I think that the UG should perhaps outline instructions on how to start the app from Terminal so macOS users can also use the application?

Screenshot Screenshot 2022-11-11 at 5.12.27 PM.png

Screenshot 2022-11-11 at 5.15.24 PM.png

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

Their Response to the 'Original' Bug

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

Thank you for pointing this out to us, it is indeed something that if included, will make the experience better for the macOS users. However, we believe that this issue arises due to differing configurations in the user's operating system, not an inherent flaw in our app/documentation. Regardless, we still think that this is an excellent suggestion and it'll be much better if we had a disclaimer for macOS users to troubleshoot commonly encountered issues (include the PE test launch guidelines, for example).

image.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]