ShyamKrishna33 / pe

0 stars 0 forks source link

Very complicated UML diagram of custom feature #12

Open ShyamKrishna33 opened 2 months ago

ShyamKrishna33 commented 2 months ago

This UML diagram is very complicated and can be broken into parts which might help the reader to better understand. The font sizes are also too small. Overall this diagram can be improved so that a new developer could understand it easily, which is the main point of the DG

image.png

nus-se-script commented 2 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

UML Diagram not comprehensible

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.


Can consider breaking down diagram into smaller components

image.png

image.png


[original: nus-cs2113-AY2324S2/pe-interim#1099] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

No details provided by team.

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.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** As the bug is not a cosmetic bug, severity.VeryLow does not fit well with this. The diagram can be improved by removing less contributing methods which can improve the understanding of the developer which is the main motive of the Developer Guide.