search

SaiChaitanya13 / pe

0 stars 0 forks source link

Repetitive visuals in Quick Start of UG #7

Open SaiChaitanya13 opened 1 year ago

SaiChaitanya13 commented 1 year ago

The visuals here are a bit unnecessarily repetitive. The images shown in the screenshot below have almost the same display with minor changes. This could have been placed in one image with the explanation below to make it more succinct.

image.png

nus-se-script commented 1 year ago

Team's Response

This is subjective. Some people can benefit from the large number of images.

Furthermore, this is at the very start in the Quick Start section, as we believe users would have reason to want to ensure they have set up and started up rainyDay correctly.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I am sorry I was simply following the notes given to us. I believe that the multiple visuals could be useful if they have more changes in them but right now there are only tiny changes and therefore, they are a waste of space and repetitive. We would want the DG and UG to be as succinct as possible.

image.png

This image was taken from https://nus-cs2113-ay2223s2.github.io/website/admin/tp-pe.html#pe-phase-1-bug-reporting-2 and it says that it is a bug in documentation if there are unnecessary visuals that are repeated, which in this case is true. I have therefore put this as "Very Low" severity.