search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Lack of troubleshooting help in UG #1521

Open nus-se-script opened 2 months ago

nus-se-script commented 2 months 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.

Screenshot 2024-04-19 at 5.13.50 PM.png

The examples are helpful for me to test out the commands, however if I run into an error message I am not able to find help on the UG, perhaps include some possible error messages of the commands for each of the commands and help the user with how to resolve them?

[original: nus-cs2103-AY2324S2/pe-interim#1925] [original labels: severity.Low type.DocumentationBug]

PallonCX commented 2 months ago

Team's Response

Thanks for bringing this up! We're glad to hear that the examples are helpful for you to test out the commands. However, we're not clear on the exact situation where "I run into an error message I am not able to find help on the UG." Hence, we have no way to reproduce such cases and evaluate the necessity of adding more information regarding the error message. We believe that a good User Guide should also be precise and concise to avoid redundant information, which can hinder the reader.

Duplicate status (if any):

--