search

jannaleong / pe

0 stars 0 forks source link

No reference made to visual used in the cluster feature in ug #20

Open jannaleong opened 4 months ago

jannaleong commented 4 months ago

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.

image.png

nus-se-bot commented 4 months ago

Team's Response

Thank you for the response, this is a valid concern. While we agree that the image can be better explained or captioned, this image is merely an attempt to offer a visual example on a possible response to a valid command (everyone in the result list in the specified location, with the disease, and unwell). Users should still refer to the command format and example inputs for usage instructions.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: Following the tp guidelines on what counts as a ug bug, it says it counts as a bug if "The visuals are not well integrated into 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 an example of the cluster command 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, the actual example you used in the visual is "cluster 2 a/ serangoon ....". This command is not mentioned in any part of your explanation of the command. 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.

Put simply, this is a case of forgetting to explain the visual you have attached that may prompt unnecessary confusion.

Furthermore, I do not believe this bug is not in scope. The purpose of your ug is to provide clarity for your commands in a user friendly document. Thus, providing clarity in your explanations and examples is a basic requirement, not something that is out of scope.

image.png