nus-pe-script
commented
4 months ago Team's Response
Nitty-gritty details missing from the UG is not a bug long as the user is informed of those details using other means such as error messages or in-app help. In this vein, I feel that the screenshot of the app with an example usage of the check command is self sufficient. A user should be able to derive from context that the screenshot of the check command GUI in the check command section of the UG, is related to the check command itself
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: Following the tp guidelines on what counts as ug bug, it says it counts as a bug if "The visuals are not well integrated to the explanation". This can be seen in the attached screenshot.
As there is no explanation provided by the ug about what the screenshot is referring to, the visuals have not been integrated into any explanation, thus it is a bug.
While I understand that as the developers of the product, you may believe it is intuitive that the image obviously shows the command "check T0234567C" and the corresponding results as your team did create and design this product. However, as the readers who may not be technically users, they may experience some confusion. For example, as seen in the screenshot in the original bug report, you mentioned a written example of "check T0234567C". But then the following bullet point mentions that it will display results for NRIC S1234567A? So, should the following visual display the command for T0234567C or S1234567A. Or is it really true that the command "check T0234567C" will display results for S1234567A? This was at least my confusion when I read your ug. While this problem may seem small, this is a point of confusion that could have been easily rectified if there was any explanation of the visual you have provided.
Also to directly address your rebuttal of "Nitty-gritty details missing from the UG is not a bug long as the user is informed of those details using other means such as error messages or in-app help", this argument is not valid as the explanation of your visual in the UG would not make sense to be placed in an error message or in app help. Also, it was not present in in an error message or in app help.
Put simply, this is a case of forgetting to explain the visual you have attached, which is especially needed as the written example you have quoted right before is flawed and prompts confusion.
No reference made to screenshotted example. Visuals should always be indicated in the explanation. For example, shown below is an example of ....
This is problematic as users may not know what the screenshot is about.