search

tituschewxj / pe

0 stars 0 forks source link

ALIAS parameter does not exist in User Guide #3

Open tituschewxj opened 5 months ago

tituschewxj commented 5 months ago

Current Behaviour

In the application, we have a/ALIAS

image.png

But in the User Guide, we have a/AFFLIATED_WITH]

image.png

Expected behaviour

The parameter a/ALIAS should be present in the User Guide.

Steps to reproduce

  1. Enter editp into the input bar.

  2. Observe the error message.

nus-pe-bot commented 5 months ago

Team's Response

I appreciate your feedback. Even though the terminologies are different, they can be assumed to be reasonably the same (since they carry a similar meaning in the English Language) and the exact same ordering.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: In this case, the meaning of the terminologies quite different, so I find it hard to assume that they are reasonably the same.

image.png

image.png

The meaning of alias is more towards an alternative name, while the meaning of affiliated with is more towards attaching or connecting to, based on the definitions above. As such, I disagree that they can be assumed to be reasonably the same.

Additionally, English may not be the native language for some users, so they may not be able to connect the two together, as the words are quite different for them.

An issue that arises is that a user may incorrectly assume that alias means another name for the patient, like a nickname, which can be used while editing a contact. It is a reasonable assumption that this is how this parameter could be used, since the editp command is meant to edit contacts, which means things like nicknames. If the user does not look up the user guide, and assumes this information, it could lead to further issues later on while using the product.

Additionally, I would like to point out the lack of an example for [a/ALIAS]... given in the error message, which adds to the confusion on what the parameter [a/ALIAS]... actually means without referring to the user guide. (So a user could assume that alias means a nickname, so this is not just a cosmetic issue)

image.png

Another issue that arises here is new users being unable to figure out what [a/ALIAS]... mean immediately. As [a/ALIAS] is a new terminology, a user would try to search up the user guide for the keyword alias, but they are unable to find anything about it immediately, which causes inconvenience.

Only when the user searches for editp, are they able to determine that both mean the same thing, due to them having the same ordering in the command format. This is not straightforward for a user to lookup what alias means.

Hence, due to the inconvenience it brings to new users, the severity should still be severity.Low.