nus-pe-script
commented
1 week ago Team's Response
Rejected, severity medium doesn't really make sense here either.
It is meant to be a summary for commands after users read through the UG.
Additionally, we split the command words as well in the features section and did not use the short form command in the format part.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: Thank you for your response.
Firstly, there is no guarantee that users will read through the entire User Guide (UG) in order. The table of contents allows users to jump directly to specific sections. For instance, a seasoned developer might only refer to the Quick Start and Command Summary sections, while regular users might rely heavily on the Command Summary, as it’s challenging to memorize 30 commands.
Secondly, while other parts of the UG correctly separate long and short forms of commands, this does not negate the issue in the Command Summary. Just because the commands are presented correctly elsewhere does not make the issue in the Command Summary less confusing.
The use of slashes here remains misleading, as it serves two different purposes. This inconsistency can confuse users, regardless of the correctness in other sections of the UG.
Given these considerations, I would like to retain this as a bug.
Thank you for your understanding.
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** Thank you for your response. I do not agree that the severity of this issue should be classified as very low, but I am willing to lower it to low instead of medium. severity.VeryLow : A flaw that is purely cosmetic and does not affect usage e.g., a typo/spacing/layout/color/font issues in the docs or the UI that doesn't affect usage. Only cosmetic problems should have this label. severity.Low : A flaw that is unlikely to affect normal operations of the product. Appears only in very rare situations and causes a minor inconvenience only. severity.Medium : A flaw that causes occasional inconvenience to some users, but they can continue to use the product. This bug is not purely cosmetic, as it affects user behavior, leading users to potentially input incorrect commands. While the issue does not disrupt the product's normal operations, it still causes minor inconvenience. Users encountering this issue would likely enter the wrong command, receive an error, and then have to consult other sections of the UG to identify the correct command. Given these factors, I believe this bug aligns more closely with the low severity classification, as it affects usage to a minor extent. Thank you.
The use of slashes here \/ is confusing, it is used to mark short and long form commands, as well to mark the labels that is allowed in the command. In the worst case the user may never be able to run a command at all.