search

yleeyilin / pe

0 stars 0 forks source link

User Guide do not have enough visuals #12

Open yleeyilin opened 2 months ago

yleeyilin commented 2 months ago

Below is a screenshot of your user guide: image.png

Expected / Possible Improvements: There can be more screenshots detailing what the users can expect. For example, it may be hard for users to understand the difference between list and list-an

image.png

image.png

This is so as to ensure that your reader / user will not be confused by the difference and can use the user guide more effectively.

nus-pe-bot commented 2 months ago

Team's Response

Could potentially be improved in the future versions. Screenshots should only be added if it helps with the understanding, and the team feels that it does not. Screenshots are also a source of additional maintenance and should be avoided if it does not add significant value as mentioned in official CS2103 website.

For your reference: https://nus-cs2103-ay2324s2.github.io/website/admin/tp-deliverables.html#deliverable-user-guide-ug

Screenshot 2024-04-20 at 9.43.56 PM.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: The TP guideline that you mentioned is cautioning against the overuse of screenshots. However, I believe that in your case, adding screenshots will not lead to an "overuse" of screenshots. In fact, it makes things clearer for your users since it is not immediately apparent as to what a user is expected to see on your app upon running the command, especially since your command is not a conventionally used command and is made specially for your use case and target audience.