HemanshuGandhi / pe

0 stars 0 forks source link

UG does not specify what happens when wrong index is input (section 3.4, 3.13) #5

Open HemanshuGandhi opened 4 years ago

HemanshuGandhi commented 4 years ago

The user is not made aware of what happens in the cases where a wrong input is given.

Screen Shot 2020-04-17 at 3.12.42 PM.png

Likewise for the following section:

Screen Shot 2020-04-17 at 3.22.06 PM.png

What should the user expect when the input is not positive integer? What should the user expect when the input is a positive integer but larger than the total number of items?

nus-pe-bot commented 4 years ago

Team's Response

We don't think the output of a wrong index keyed in for the commands will hinder the reader in the UG. Furthermore, when these invalid inputs are entered in the application, the relevant error messages will be displayed.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: If there is a chance this command will fail, then the user guide should at least guide the user on what to do when something goes wrong. This is entirely the reason why realistically, user guides spend more time talking about "troubleshooting" rather than what happens in the ideal scenario.

As the team acknowledges, "We don’t think the output of a wrong index keyed in for the commands will hinder the reader in the UG.". Therefore, If the output will help the reader, then it should be included in the UG.

"when these invalid inputs are entered in the application, the relevant error messages will be displayed." - If this is indeed the case, then this is an important point that should be specified in the user guide instead!


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]