soc-pe-bot
commented
2 months ago Team's Response
Same problem in issue #532
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Extremely small text in Class 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.
There is a very detailed class diagram in the user guide but it is too complicated, making the text too small to see. The PDF had to be zoomed in 200% for the diagram labels to become barely legible. Consider splitting it into several smaller diagrams as the course website states text size in diagrams should be around the same size as the one in documentation.
[original: nus-cs2113-AY2324S2/pe-interim#470] [original labels: severity.Medium type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
high res image provided
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.Medium`] Originally [`severity.High`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
Do consider using a simpler diagram or multiple diagrams as this is really too small to be understood by developers. This is considered severity.high as it makes this section almost unusable by developers since they cant see the text nor the arrows.