trash-bin99 / pe

0 stars 0 forks source link

Insufficient visuals in the User Guide #8

Open trash-bin99 opened 2 years ago

trash-bin99 commented 2 years ago

In the whole User Guide, there are only 3 screenshots provided, and there are no other visuals provided to help readers understand how UNion works, the different parts of the UI of Union and examples of how each command should look like when they work.

nus-pe-bot commented 2 years ago

Team's Response

image.png

We believe that the 3 screenshots provided are sufficient. Adding extra screenshots wouldn't add extra value. In fact, it would be harder to maintain, and might clutter our UG as a whole.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: In my opinion, there is insufficient visuals in the UG, as there was not enough material to help readers with understanding the various features at several points. For example, the entire section for the command mkdir is provided below.

image.png

While the description is short, it is hard to visualise how a folder is created. A screenshot providing labels of where the folders would be created would have been helpful in guiding readers to how the command works.

In general, the UG has been quite lacking in visuals throughout the document, hence I believe that the issue still stands.