search

nus-cs2113-AY1920S2 / pe-dev-response

0 stars 0 forks source link

Cluttered usage in the UG #574

Open nus-pe-bot opened 4 years ago

nus-pe-bot commented 4 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 Usage section inside the UG seems to be too overcrowded with information that can be found in the explanation of usage in the basic commands already. One suggestion is to reduce the number of examples and to focus more on the format and basic uses of the commands.

[CS2113-T15-1][Jikan]UG.pdf - Adobe Acrobat Reader DC 15_4_2020 1_32_51 PM.png [CS2113-T15-1][Jikan]UG.pdf - Adobe Acrobat Reader DC 15_4_2020 1_33_02 PM.png

[original: nus-cs2113-AY1920S2/pe-interim#570]

btricec commented 4 years ago

Team's Response

The usage section was intended to give users a comprehensve overview of our app. Understand that this section was not compulsory but felt that it would be nice to show new users the contintuity of our commands to give them a better understanding of how the app can be used.

Format and basic uses of commands, and also a summary, are all included. The usage section was not intended for this.

Duplicate status (if any):

--