UG: findc images not explained.

[eugenetyc]

see title.

[nus-pe-bot]

Team's Response

Examples and explanations are provided below the images in the UG.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

• [x] I disagree

Reason for disagreement: This is how the section of interest appears in the UG.

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 are just some screenshots lumped together 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 3 worded examples but 2 screenshots.

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:

1. They performed the command
2. They reenter the command
3. 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 user 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 not the only instance where the screenshots/diagrams are just left 'hanging' without an explanation and assumed for the user to guess how to use or interpret their meaning.

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.

---