angjunkang / pe

0 stars 0 forks source link

Not enough visuals in UserGuide #11

Open angjunkang opened 1 year ago

angjunkang commented 1 year ago

Could perhaps consider adding more screenshots of the usage of your commands in the UserGuide

nus-pe-bot commented 1 year ago

Team's Response

Our commands are all text based, so adding the visuals may be something to be considered in future iterations of this product where the user inputs are more varied. So this comment is valid, but not in the context of our current features in this iteration.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: I don't agree with a NotInScope response.

In the CS2103 website, it states:

These are considered UG bugs (if they hinder the reader):

Use of visuals Not enough visuals e.g., screenshots/diagrams The visuals are not well integrated to the explanation The visuals are unnecessarily repetitive e.g., same visual repeated with minor changes

There is nearly 0 visuals in the UG and I feel that visual is not just for commands that are not text based. Visuals can help provides context by giving users a visual representation of what they can expect to see on their computer screen. This can be particularly helpful for users who are new to the application or who are unfamiliar with the terminology used in the guide. It can also enhances clarity and comprehension by helping users to explain complex concepts in a simple and easy-to-understand manner. By incorporating screenshots into a user guide, users can quickly understand the steps needed to complete a particular task within the application.