search

Goh-Li-Ting / pe

0 stars 0 forks source link

Error message parameters different from user guide for add-appt #4

Open Goh-Li-Ting opened 10 months ago

Goh-Li-Ting commented 10 months ago

The parameter names used in the user guide and in the error message are different, which can cause confusion for the users.

User guide: image.png

Application error message: image.png

soc-se-bot commented 10 months ago

Team's Response

Although we agree that they're not the same, we disagree that it may cause confusion - any Singapore resident would be able to tell that the 2 terms NRIC and IC are interchangeable.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I acknowledge that both formats will not lead to confusion about the command usage for the user as they are still able to convey the correct information to the users. However, I still believe that this is a cosmetic problem. As a user referring to the user guide, I would question why there is a difference between the given format in the user guide and the parameters in the error message. While this does not hinder the user's usage of the application, this can still lead to the user's feeling confused about why there is a difference.

Furthermore, in the user guide, UPPER_CASE format is said to be used to denote the parameters to be supplied by the user. However, PATIENT IC, DOCTOR IC, APPOINTMENT TIME and yyyy-MM-dd HH:mm do not follow this format. I believe that while the user is still able to understand what both the user guide and error message are saying, the lack of standardisation may cause users to wonder why there are differences.

image.png

There is also no mention in the user guide that yyyy-MM-dd HH:mm refers to the appointment time. While a user should be able to infer that that is the appointment time, it still differs from the parameter format.

In conclusion, I believe that this is a cosmetic issue.