search

Devanshshah1309 / pe

0 stars 0 forks source link

Overly Generic and Not Useful Help Messages #3

Open Devanshshah1309 opened 1 year ago

Devanshshah1309 commented 1 year ago

Steps to Reproduce

Run delete task 10

Expected

If the command format is incorrect, the application should guide the user on how to correct the format (either by saying "Please try the help information for more information" or some other help message). It is not very useful to know that the command format is incorrect as there's nothing the user can do with that information. At least including a link to the UG with every help message could have helped.

Actual

Screenshot 2022-11-11 at 4.26.45 PM.png

nus-pe-bot commented 1 year ago

Team's Response

We have a help tab and a help command to guide the user. And it is stated clearly in our UG

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I think this is a valid bug as it causes minor inconvenience to the user. Rationale is as follows:

  1. The app is meant to be used primarily via CLI. So, the clicking the help tab is quite inconvenient. Moreover, the help tab doesn't really help the user at all. It just provides a link to the user guide, and the user has to navigate through it to find the right command.
  2. The help me command just opens the help window and doesn't actually help the user find the correct format quickly

The issue is that there is no way for a user to get help within the application (without the user guide). It is inconvenient if I have to search the UG every time I forget the command syntax format.

It would have been easier to get help if you had some help message along with each command - to aid the user in typing the correct format.

The current error message of unknown command format doesn't even tell the user to "Please run help me for more help" or anything. Hence, I feel this bug should not be rejected as there is no form of in-application help.

After some consideration, I feel the severity of this bug is severity.low as it only causes problems in occasions where the user forgets the command syntax and does not have access to internet to access the UG (or even if he/she has access to the internet, is is inconvenient to open a new tab on a browser just for one simple syntax).

The comment in the original issue still stands:

If the command format is incorrect, the application should guide the user on how to correct the format (either by saying "Please try the help command for more information" or some other help message). It is not very useful to know that the command format is incorrect as there's nothing the user can do with that information. At least including a link to the UG with every help message - or "unknown command" message

  • could have helped.

:question: Issue severity

Team chose [severity.Low] Originally [severity.Medium]

Reason for disagreement: [replace this with your explanation]