search

nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Inconsistency of launching steps #1611

Open nus-pe-bot opened 1 week ago

nus-pe-bot commented 1 week ago

In the User Guide, it is mentioned that we have to type java -jar clientell.jar to run the app. image.png

However, the DG states that you can run the app by double-clicking. image.png

This might confuse the developer which one to do (as developer is also a user).

Not verylow because this is not a cosmetic issue.

[original: nus-cs2103-AY2425S1/pe-interim#2215] [original labels: severity.Low type.DocumentationBug]

trpmy commented 1 week ago

Team's Response

As the UG is written for a non-technical audience, we included step by step instructions to launch the app via more "manual" method of running java -jar clientell.jar.

The DG is written for a technical audience, who should be familiar with how to launch an application. We don't believe that a developer reading our Developer Guide would face the confusion you've characterised, with regards to how to start an app. As such, we also allow the double-clicking as a more short-cut way to launch the app, especially when the reader of the DG is likely doing this operation many times to test the app. It is also why we do not reiterate any of the quick start steps in the DG (because if we did that, it might've also been considered a bug due to 1. mismatch of target audience and 2. unnecessary/lengthy/irrelevant details).

As a gesture of good faith, we still recognise that the DG may have benefitted from maybe an additional section to explain all possible ways to launch the app for the technical users who are more adept. As such, we settled on NotInScope, recognising this possible, nice-to-have improvement (and also to credit the tester a little).

Duplicate status (if any):

--