limrik / pe

0 stars 0 forks source link

Lack of troubleshooting help in UG #10

Open limrik opened 4 months ago

limrik commented 4 months ago

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?

nus-pe-bot commented 4 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.

Items for the Tester to Verify

:question: Issue response

Team chose [response.CannotReproduce]

Reason for disagreement: Hi, thank you for your response.

In this case I did not include any examples as I am simply referring to the fact that no troubleshooting help was included in your User Guide. This could possibly be the cause of many tester's misunderstandings as the User Guide is unable to provide more help on the issue. Furthermore, your application throws the generic "Invalid command Format exception" on most commands, hence making it very difficult to test as both your application and User Guide fail to provide the user with sufficient help.

On further consideration, I would like to raise the severity of this to medium, as it causes inconvenience to some users (especially testers) but they can continue to use the product.