search

nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

[UG] expected outputs when error #3288

Open nus-se-script opened 1 week ago

nus-se-script commented 1 week ago

Expected outputs when error occurs are not mentioned in the User Guide.

[original: nus-cs2103-AY2425S1/pe-interim#2188] [original labels: severity.Medium type.DocumentationBug]

Kitty-001 commented 1 week ago

Team's Response

Thank you for the suggestion. However, our team believes that the benefits of doing this does not outweigh the negatives.

As there are many possible invalid outputs with different errors, it will take a lot of space to show and explain them. Including such details would unnecessarily clutter the guide and detract from its main purpose of instructing users on how to use the application effectively.

Furthermore, our application provides clear and specific error messages directly to the user. User can easily correct their input according to the error message shown in the UI, so I think it's not necessary to duplicate this information in the User Guide.

Duplicate status (if any):

--