nus-pe-bot
commented
2 months ago Team's Response
Thank you for your feedback regarding the UML diagram in the Model component of the Developer's Guide. We understand the importance of clarity in visual representations, and we apologise for any difficulty you've experienced in reading the diagram. We will review the sizing of the diagram and explore options to resize it appropriately, taking advantage of the available space to enhance readability. We have also indicated it as VeryLow because it does not affect the operations of the application.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
DG Image for Model
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.
Currently the image only occupies about 60% of the width of the page. Given the fact that the image contains a lot of information, it is a struggle to read the contents of it. I believe that the width could be set larger to occupy more space, to allow better viewability.
[original: nus-cs2103-AY2324S2/pe-interim#3165] [original labels: type.FunctionalityBug severity.VeryLow]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
Thank you for bringing up the issue regarding the size of the DG image for the model. We acknowledge the importance of readability and understand that the current size may hinder the visibility of the information contained within the image. We will review the layout and increase the image to allow for better viewability and readability of the contents.
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`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
The provided UML diagram is as follows:
This UML diagram is relatively small compared to other diagrams, like those listed above, for example:
This results in the diagram being difficult to read. Considering there is extra space to the right of the model, it could be possible to resize the image to make it easier to read.
*Note that it is difficult to capture the exact scale of the diagram with the images provided alone.