search

nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

[DG] Information to Start the App is Incorrect/Inconsistent #2239

Open nus-pe-bot opened 2 weeks ago

nus-pe-bot commented 2 weeks ago

Based on DG, readers are asked to double-click the jar file to launch the app. However, they should use the java -jar command to launch the jar file instead as given below. image.png

Moreover, this instruction do not correspond to what was stated in the UG where users were asked to use java -jar to launch the app. This can confuse the readers as they would not know which method to follow.

DG:

image.png

UG:

image.png

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

waihongteh commented 2 weeks ago

Team's Response

For User Guide and Developer Guide, the target audience for User Guide is readers without any tech expertise while Developer Guide is readers who expert to have some tech expertise. For UG, we states explicitly the exact process that should be executed to launch the program, while for DG, given an expectation on some expertise for the developer who testing our program, we using double-click for the description in DG is as the method to launch the program.

Your suggestion to be more consistent for both UG & DG reasonable but in current version, it does not really affects user testing experience while it has lower priority than the work already done in current version. We will make it respond.NotInScope hopefully it is reasonable enough as this is not considered a bug that create any misbehavior for the users.

Duplicate status (if any):

--