search

glenngnng / pe

0 stars 0 forks source link

Sequence diagram of view_leave in DG is too small #16

Open glenngnng opened 10 months ago

glenngnng commented 10 months ago

image.png

It is extremely hard to read the words in the diagram.

It hinders the user since they have to zoom into more than 200%

nus-se-script commented 9 months ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Poor formatting for leave feature sequence diagram in DG

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

image.png As shown in the image, the method calls are extremely small and difficult to see without zooming in. Ideally, the font size should correspond to the rest of the DG. Perhaps better formatting could be used here!

[original: nus-cs2103-AY2324S1/pe-interim#4954] [original labels: type.DocumentationBug severity.VeryLow]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

I tried my best to make it as wide as possible for one A4 page but I do agree it is still pretty small, probably due to the class names and method calls being pretty long.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** I don't believe this is a purely cosmetic issue. It is an incorrect sizing issue that will hinder the reader. Hence, it should be severity low. Furthermore, to prove my statement on why it should be low: The user has to first zoom in, and scroll left and right. In another scenario, instead of scrolling, the user might have to maximize their pdf viewer window in order to fully capture the details, when they were previously using a minimized window to view the guide and the app side by side. All in all, these extra steps will hinder the reader through less efficient reading.