debwy / pe

0 stars 0 forks source link

Formatting of UG should be improved #5

Open debwy opened 2 years ago

debwy commented 2 years ago

Images are too large (no width/height control perhaps?) and they take up an entire page. This leaves images that are not well tied into the explanation.

Furthermore, there are pages in which there is but a single line of text due to this (refer to screenshot). This makes reading through the UG quite painful.

Screenshot (7201).png

nus-se-script commented 2 years ago

Team's Response

Does not hinder the reader. The images are big so that reader can have a better time viewing the image. These page breaks were used to make the sections of the UG more organized and less cluttered.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Not controlling the size of the diagrams mean that diagrams & explanations are frequently split between pages. The fact that image layouts are not standardized doesn't help either (one image shows the full application, that takes up half a page, the next shows a zoomed in picture of the list which takes up the whole page, etc.) This, coupled with the team not mentioning exactly which image the text is referring to (e.g. 2 images, text, 2 images, text, etc. --> exactly which of the images is the text meant to be referring to? This made navigating the examples extremely hard (debatably harder than if there had been no images at all))