woozije / pe

0 stars 0 forks source link

Class diagrams do not comply to what we have learnt #13

Open woozije opened 3 years ago

woozije commented 3 years ago

image.png The icons beside the classes, method names as well as the way the classes are grouped together in the class diagrams do not seem to comply to the class diagrams we have learnt in class. Perhaps a legend or note to refer to the different icons might be easiser for the user when reading it.

nus-pe-bot commented 3 years ago

Team's Response

since we used plantuml to draw our diagrams there are limitations to the tool, you could refer to their website for the syntax (https://plantuml.com/class-diagram)

here's the visibility syntax table as an example:

Screenshot 2020-11-16 at 2.42.14 AM.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Referring to Prof's tip in github forum issue 112, it was stated that this is considered non-standard UML notation. In addition, there is a way to turn off the icons as well.

image.png


:question: Issue severity

Team chose [severity.High] Originally [severity.Medium]

Reason for disagreement: Severity may not be that high as it is still readable and does not cause a major problem.