search

jetlfj / pe

0 stars 0 forks source link

Format for Class Date Day not specified clearly in UG #3

Open jetlfj opened 1 year ago

jetlfj commented 1 year ago

image.png

It is not explicitly stated that Day-of-Week must be of a certain format (3 letters) so users will likely try other inputs such as Monday or 1 instead of Mon, which will not work and they have to read the error message to figure out what's wrong.

Edit: It is only specified in the Glossary, but most users will miss it because Day-of-week seems to be quite self-explanatory.

nus-pe-bot commented 1 year ago

Team's Response

There were sufficient examples provided and the explanation is provided in the glossary. So the fact that the tester has pointed it out means that it is possible to find out information regarding this so there should not be any confusion. Moreover, there is an error message provided in the application when there is invalid input and the tester is expected to read the error message. Otherwise, the purpose of error message is defeated.

This is a screenshot of the glossary section:

image.png

This is a screenshot of the error message: image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Yes, the error message has a purpose but you are missing the point here. If the user has already read the User Guide, and follow the instructions provided, they expect to be able to use the application correctly without any errors at all. So, using the error message as an excuse for this documentation bug is not justified.

Also, the Glossary which explains what Day-of-Week is, is near the bottom of the User Guide, far below where the term Day-of-Week is used in the edit feature section. As such, most readers will likely miss it while trying out the application. Furthermore, you stated that there were sufficient examples provided to make this clear. However, there is only one such example Mon (MON is just there to show case-insensitivity). You can argue that users can possibly infer that it is an abbreviation, but not necessarily a three letter one. Tues and Thur are commonly used abbreviations for certain days of the week, but are not accepted as valid inputs here.

:question: Issue severity

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

Reason for disagreement: I don't think you are supposed to both reject AND lower the severity of a bug report. You can choose to do one or the other, but not both. The fact that you are lowering the severity instead of outright rejecting it means that you are acknowledging that the bug exists in the first place, albeit at a lower severity.

Nevertheless, this should still be a severity.Medium. It will cause occasional inconvenience to the user as they have to edit the class time of each student when they are added.