search

nus-cs2113-AY2021S1 / pe-dev-response

0 stars 0 forks source link

Summary is not beginner friendly #733

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.

Summary is not beginner friendly. The commands given here are not what beginners were told to use. Also, if one jumps straight to the summary, they would not know what the square brackets are for, nor would they know the valid input formats. Screenshot 2020-11-13 at 5.49.35 PM.png

[original: nus-cs2113-AY2021S1/pe-interim#678]

amanda-chua commented 3 years ago

Team's Response

This is how Athena is supposed to be used. We decided to make the summary short and concise so we did not include the beginner usage. For a beginner, I think he/she needs to go through the user guide step by step and not straight to the end of the document for the command summary.

Duplicate status (if any):

--