Yuvaraj0702 / pe

0 stars 0 forks source link

Lack of images in the User Guide #4

Open Yuvaraj0702 opened 1 year ago

Yuvaraj0702 commented 1 year ago

Description: The user guide is very text heavy and although images are provided (total 6). More images can be provided for some of the complex command to show the expected outcome. Example would be images for find -p as the search mechanism might not be a conventional one.

nus-se-script commented 1 year ago

Team's Response

Thank you for the feedback. At the same time, we were cautious of overusing screenshots. In particular, you mentioned that find -p should have a screenshot, but we included a screenshot for the similar command find -c. Because of this, we decided against including a screenshot for find -p because it would be overly repetitive.

image.png

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The dev team makes a valid point. However, the similarity of these features may not be apparent to the user who has no idea what your product does. This similarity is also not explicitly stated. Furthermore find -p appears before find -c in the user guide and a more appropriate way to possibly limit the images used would be to include find-p and at find-c place a link to find -p and state that the output is similar. This is the same for all functions regarding the property field as they all appear before the clients and there are no images or links. With no such accompanying information, the user is left to wonder what the output will look like. In addition, there are commands such as filter and clear that don't have images. Hence, even though the dev team makes a good point they could have done more to fix this bug. Thus, the tester respectfully disagrees with the dev team.