spinoandraptos / pe

0 stars 0 forks source link

Not enough UG documentation on what happens for the retries after delete command #10

Open spinoandraptos opened 8 months ago

spinoandraptos commented 8 months ago

image.png

It is unclear as to what happens if i key in "no" only on the 3rd retry for instance, more visual documentation can help users better understand the meaning and use of the feature.

nus-se-bot commented 8 months ago

Team's Response

Our target user is primarily a clerk, someone who is familiar with computers and software. In this case, the outcome of typing no should be quite self-explanatory, and is very unlikely to cause any issues for the user.

However, we note your point nonetheless as something to improve on.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: image.png


This bug is not a purely cosmetic issue as it can cause inconvenience to users, especially those who do not appreciate the rationale behind the 5 tries feature. For instance, the documentation does not show what happens when random input is keyed in, and also does not show documentation for what happens when the program does not accept the input (does it ignore the input or terminate the command process for eg.) although these are very likely inputs by new users. In particular, based on the given documentation, users could be wondering why there are 5 tries but the entry was deleted with just a single "yes". Users will have to figure out how exactly the 5 tries feature works through trial and error mostly, by trying different combinations of inputs. Since delete is a command which users will likely frequently use, the lack of documentation does affect the usage of the program by introducing potential confusion especially for new users, and leads to inconvenience as users need to spend time to learn the functionality of the feature themselves.