search

yongmingyang / pe

0 stars 0 forks source link

Better phrasing for page 11/34 of the UserGuide on MAX_QUANTITY #8

Open yongmingyang opened 3 years ago

yongmingyang commented 3 years ago

I refer to the Note portion of the following:

image.png

Instead of calling it "hard cap", rephrasing as "MAX_QUANTITY is not a limit on the amount..." would have been better.

Furthermore, the term MAX_QUANTITY indicates that nothing should go beyond the "max", otherwise it shouldn't be known as "max". Hence, a more appropriate term such as "IDEAL_QUANTITY" should be used here to prevent any possible confusion.

nus-se-bot commented 3 years ago

Team's Response

hardcap: has the same meaning as what the tester wants IDEAL_QUANTITY: There may be some merit to this, but we've already clarified what max_quantity refers to serveral times in the UG. Reason being is that supposedly it is the maximum quantity but we do not want to restrict the Restaurant owner from supplying more at certain times. If there is a new max quantity, restaurant owner should edit the max quantity to be higher instead.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: I do not see why this issue is classified as not in scope.

1) Hardcap is not an actual word, it is only found in urban dictionary and hence, may not be understandable for people who are not familiar with the term.

image.png

image.png

2) I do not disagree with the fact that max_quantity has been defined as in your UG. As I mentioned, there is no point in labelling something as maximum if there is no reinforcement of the meaning of max, and this only adds confusion to the user. Furthermore, I think that having a better name would improve the user experience. Also we have learnt that constant/variables/functions should depict accurately what they are about.

:question: Issue severity

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

Reason for disagreement: I think that the severity should still be low because if the user misunderstands the term max_quantity as the literal definition of max quantity, he may encounter issues.

e.g. consider the following scenario:

1) A restaurant owner sets the max for rice as 100kg 2) Due to his busy work nature, he skims through the user guide, and does not take note of the details 3) Thinking that he has already set a max of 100kg and therefore should not be able to exceed the amount, in a haste, he tops up 30kg without looking at the current quantity 4) Assuming he was at 80kg initially, he now has 110kg of rice and has overstocked, possibly leading to wastage of money just because of the use of the term MAX_QUANTITY which did not actually mean he couldn't exceed.

Hence, I think this issue would actually affect the user quite a bit, especially for the target audience