search

nus-cs2113-AY2324S1 / pe-dev-response

0 stars 0 forks source link

UG flaws #1042

Open nus-pe-bot opened 10 months ago

nus-pe-bot commented 10 months ago

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.

9.PNG i think u could include a more detailed guide on how to setup the program. an average user would not know what is runtime environment and where to find the official repo or even how to download it. some users might not even understand what a home folder is. most would not know how to open a command terminal and use commands such as cd.

[original: nus-cs2113-AY2324S1/pe-interim#1022] [original labels: severity.Medium type.DocumentationBug]

DaDevChia commented 10 months ago

Team's Response

There is a link at the top of the User Guide to link to the official Github repository for the user to download the software.

It is mentioned in the User Guide that the application is a Command Line Application, and sets the expectation that they would know basic terminal commands and navigate to the home folder and file.

We do concede that it would be better if the runtime requirement is better specified (Java 11).

We argue for the categorization of this bug to be Severity.Low instead of Medium, as the issue of Quick Start requirement being lacking only causes a problem for Users that are less technical, a situation unlikely where the target user is Command Line oriented.

Duplicate status (if any):

--