nus-pe-bot
commented
4 years ago Team's Response
Firstly, the command is already explained in the statements above the picture. The picture purely provides a visual guidance on where to input the command, how the window will look like etc. The description of the command provided is already clear enough.
Moreover, the examples are given below the picture, further supporting the fact that the picture is used to visualise how an example of the command is used.
Lastly, even if it is a flaw, it is purely cosmetic and does not impact product usage in any way, since the picture only serve to aid in understanding. With or without the picture, the descriptions are clear enough for the user to understand the command usage.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: The explanation for this bug report can be similar to that of bug report:
UG: findc images not explained. (the bug report justification in this 'findc ...' mentioned bug report is more comprehensive, and includes parts beyond the explanation for the initial bug)
After taking time to review them (we were squeezed for time during the PE so much that I didn't have time to re-review my bug reports), I can completely understand if the teaching team marks these 2 as duplicates.
Moreover, I will re-explain the relevant parts here.
Firstly, this section of the UG explains how the command works. Therefore, the team's UG should be having a mini-tutorial or a few screenshots showing the processes of using the command. What they have here is just one screenshot in one subsection, and then some worded examples in the next subsection. One cannot really tell if the worded examples are even related to the screenshots, especially since there are 2 worded examples but 1 screenshot.
Moreover, there is no immediate explanation directly under the screenshots. All they do are just showing results for the particular command that appears in the command box, but this is how they got the screenshots:
- They performed the command
- They reenter the command
- They take the screenshot
Yet the issue is that to a user, when he/she performs the command, the command input dissapears when the command is executed. Therefore it is not wise to reenter the command and then take a screenshot, because it will not appear so to the user. This makes the users, especially those not tech-savvy, confused. Adding on, these screenshots don't have even a basic description of what is going on exactly in that screenshot, and are simply left to the user to guess what exactly is going on. This is poor user-centricity, and the fact that having no explanation for the screenshots/diagrams makes this indeed a bug that should be accepted, as with CS2103/T guidelines. This is another instance where the screenshots/diagrams are just left 'hanging' without an explanation (an example being the abovementioned other bug report) and assumed for the user to guess how to use or interpret their meaning.
:question: Issue severity
Team chose [severity.VeryLow]
Originally [severity.Medium]
- [x] I disagree
Reason for disagreement: Adding onto the above:
Once again: After taking time to review them (we were squeezed for time during the PE so much that I didn’t have time to re-review my bug reports), I can completely understand if the teaching team marks these 2 as duplicates.
Moreover, this is all the more a bug because of the inconsistencies in explaining, and not explaining diagrams.
Taking a look at the Transactions section of the UG, there are sometimes indeed explanations of the screenshots/diagrams, in constrast to other sections with no explanations, as seen below.
As such, while we have established this is indeed a bug, I have classified this as Medium severity because of the following guidelines:
Clearly, to a user who wants to learn more about the application, this lack of explanation makes it inconvenient for me to know or guess what is going on for each command or feature, and the inconsistency of explanation is quite a cosmetic personal trouble, since I have to adapt myself differently to interpret different parts of the inconsistent UG correctly -- once again, inconvenience and inadequate user-centricity.
Lastly, the above sections have images and some do not:
This makes it difficult for the user to visualise what will actually be shown on the app without opening and testing it on the app (inconvenience). Also, it makes the UG more difficult to navigate as users assume each relevant section to a command or feature should have relevant diagrams/screenshots. This reinforces my bug report's validity, which is a Medium severity Documentation Bug.
UG addp should explain the diagrams. Not just leave them there.