nus-se-script
commented
2 years ago Team's Response
Duplicate of issue #1966
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Size of model UML diagram
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.
The size of the model UML diagram is too small to see.
[original: nus-cs2103-AY2122S2/pe-interim#1954] [original labels: severity.Low type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
It is a cosmetic issue. Hence should be very low. Readers can zoom in to look at the image.
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)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
:question: Issue severity
Team chose [severity.VeryLow]
Originally [severity.Medium]
- [x] I disagree
Reason for disagreement: While in usual cases the issue might purely be cosmetic, this case is particularly egregious considering that even after zooming in, it is nigh impossible to see the text in the diagram.
Referring to my original screenshot:
An argument can be made for the third diagram as it can still be seen with zooming, but the first two diagrams are so small that even after zooming in 200% it is still difficult to make out the text:
This actively hinders developers trying to read the DG to understand the structure of the program, and is not purely a cosmetic issue.
Additionally, going by the textbook:
The bug fits the description of Medium considering that it causes inconvenience to the reader, even though they can continue to use the DG elsewhere.
Some of the images in the DG are too small and not readable, even if you try to zoom in within the PDF reader. See below for example:
200% zoom: