soc-pe-bot
commented
1 year ago Team's Response
No details provided by team.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Difficult to see the model 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 model diagram on the DG is shown below. As one can see, it is difficult to read the content written within the diagram. Perhaps making the diagram bigger would be helpful.
[original: nus-cs2103-AY2223S1/pe-interim#4037] [original labels: type.DocumentationBug severity.Low]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
Although this could be considered as as cosmetic issue, we feel that the readability of an image is very subjective and in this particular case, in order to accommodate a complex diagram like that of the
Modelcomponent, we feel that the size is appropriate and readable on print.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 response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: I agree with the team that the readability of an image subjective.
However, the issue with this image is that as compared to the surround text, it is not readable.
For example, if a developer finds the bulk of the DG comfortable and easy to read at a zoom level of 100%, he must zoom in to 150% (as an example) to view the diagram comfortably. Let say instead, the entire DG is in the same font as the diagram, then the developer would not need to zoom in more in order to view the entire DG comfortably. He can just set the zoom at 150% and read everything comfortably.
The issue is that the developer must constantly zoom in and out in order to view the details in the diagram. This causes inconvenience for the developer.
As compared to the font size of the explanation text below, this UML Diagram is too small for the developers to view. Would have to resize between viewing the text and the UML Diagram. This cosmetic issue causes minor inconveniences.