search

ltzehan / pe

0 stars 0 forks source link

Diagrams in DG overlap with text #13

Open ltzehan opened 1 year ago

ltzehan commented 1 year ago

The DG is difficult to read as some of the UML diagrams overlap with the text

image.png

image.png

image.png

nus-pe-bot commented 1 year ago

Team's Response

Result from wrong layout chosen during PDF conversion of the webpage. Readers/Users can fallback to the online version of the Developer Guide for reference.

The 'Original' Bug

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

Pages 4 ,12 and 14 of the DG pdf are basically unreadable

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.

Untitled13.png

There seems to be a diagram overlaying the words on Page 4 of the DG, this greatly hinders the reader

Untitled14.png

There is the same issue on page 12.

Untitled15.png

And page 14.

I also see it on page 16, albeit less severe.

[original: nus-cs2113-AY2223S2/pe-interim#2838] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

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

Reasonable, however readers can fall back to the online version of the Developer Guide. The PDF version was bad due to poor conversion due to wrong layout chosen.

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.Medium`] Originally [`severity.High`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]