search

NorbertLoh / pe

0 stars 0 forks source link

Model uml does not seem to match software #10

Open NorbertLoh opened 1 week ago

NorbertLoh commented 1 week ago

Background

In the DG the model is expected to contain a person with name, phone, address, email and tag. Assuming person is the supplier, there should not be email there as it does not exists as a field in the software

image.png

Expected

email to be removed from the model for person

Actual

image.png

Why this severity

This is a medium severity as it can cause serious confusion to a developer taking over this project and looking at the DG. They would create a person with email and the code would not able to handle it. Thus, essentially making the model uml incorrect and unusable.

nus-pe-script commented 1 week ago

Team's Response

We concede that this is an important oversight in the DG UML diagram, which developers are looking at for class composition information.

However, we have relabeled it as a low severity. This is because an additional inclusion of an email class does not affect the conceptual understanding of the person model when the developer is taking over.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: I assigned this issue a medium severity because the inclusion of an email field in the diagram raises significant concerns. Why should this field appear if it is not utilized anywhere? Upon examining your repository, I also discovered that Email.java does not exist, further confirming this inconsistency.

Additionally, according to the textbook, even minor UML notation errors such as (using a dashed line instead of a solid line) are considered low severity issues. By comparison, the inclusion of an email field that is neither implemented in the code nor supported by Person.java represents a more serious flaw. This mismatch undermines the accuracy of the design and could lead to confusion for developers referencing the diagram. Hence, I believe this issue warrants a higher severity rating as it makes the diagram unreliable and unusable.

image.png

Thus, I believe it warrants a medium as the UML diagram has a serious flaw as it is inaccurate, unusable and any developer taking over will be highly confused.