search

nus-cs2113-AY2021S2 / pe-dev-response

0 stars 0 forks source link

The user guide lacks a section on explaining the conventions used, hence makes it confusing for the reader. #1141

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.

There is lack of a section for explaining the conventions and formats used in this user guide:

image.png

Hence it is confusing for the reader to understand what different font formats and notations mean. Some examples shown here:

image.png

image.png

image.png

[original: nus-cs2113-AY2021S2/pe-interim#1141] [original labels: severity.Low type.DocumentationBug]

ongweisheng commented 3 years ago

Team's Response

Thank you for your feedback :)

We believe that the format conventions and formats are not needed as there are detailed explanation and details provided to the formats when mentioned. Also, it makes sense to put notes about the command format under features as these notes are for the various commands in easyLog. Users look at it first to know more about what commands are valid / invalid.

Duplicate status (if any):

--