search

nus-tic4002-AY2021S2 / pe-dev-response

0 stars 0 forks source link

UG not well-format and hard to understand #134

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.

The format of UG is hard to understand and not well-formatted. For example, the feature of creating a group feature suppose to be put before the add feature as the add feature have an example of g/. the user will assume that the group cannot be added as there is nothing happen. Meanwhile, the clear, exit, saving data is best to put the last as the user will assume that that is the end. and follow the step to clear all data and exit.

[original: nus-tic4002-AY2021S2/pe-interim#134] [original labels: severity.High type.DocumentationBug]

HongJiancheng commented 3 years ago

Team's Response

I accepted the flow of the UG should be improved, but I think the overall flow of the commands in feature section does not hugely impact user's understanding of the program workflow which has been stated in Quick Start section.

Duplicate status (if any):

--