search

nus-cs2103-AY2021S1 / pe-dev-response

0 stars 0 forks source link

Missing cover page and UI section #5971

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 years 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.

it would be great if the Table of Content is not the first page of the UG. Also, there should be a section documenting the UI interface. In your first instruction, it is mentioned type into the command box. As a non-tech savvy user, and without a UI seection detailing the naming of different UI element, I do not know what a command box is image.png

[original: nus-cs2103-AY2021S1/pe-interim#5958]

jazerler commented 3 years ago

Team's Response

A cover page is not necessary for a User Guide.

Furthermore, the argument of 'not knowing what a command box is' is flawed, as the program already displays the "Enter command here..." in the command box (see red rectangle below), which should be intuitive enough for non-tech-savvy users.

image.png

Also, AB3 UG does not include a cover page either, so this is a "bug" (if you can call it that) inherited from AB3.

Duplicate status (if any):

--