acekhoon / pe

0 stars 0 forks source link

Over-usage of the screenshots for UG where the size of screenshot does not fit well with the document. #10

Open acekhoon opened 2 months ago

acekhoon commented 2 months ago

The number of screenshots in the UG seems to be a bit much as a reader of this user guide. For instance, clear method would not need screenshot as it is simple command that the user already knows what to expect. Moreover, the size of description of the command and the size of screenshot are disproportionate where the size of description of the command (including command format, examples..etc) are written in a small font but the size of screenshot is huge, which intermittently disrputs the readability of the user guide.

Example:

Screenshot 2024-04-19 at 5.20.32 PM.png

soc-pe-bot commented 2 months ago

Team's Response

We find that this is a matter of personal taste.

For clear, although it is implicit, it is important to give confirmation to the user of what it should look like.

We do not find that the image sizes are jarring.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: As a reader reading this user guide, I needed to zoom in and out multiple times due to the fact that the size of screenshot is very big but the font size that explains the examples and command syntax is very small, which I found it jarring to read. Plus, screenshots are indeed overused where some screenshots