search

oneBoz / pe

0 stars 0 forks source link

[DG] BetterModelDiagram has missing classes and there should be no UniqueTaglist #8

Open oneBoz opened 1 week ago

oneBoz commented 1 week ago

Screenshot 2024-11-15 at 5.32.24 PM.png

Should also include remark

soc-pe-bot commented 1 week ago

Team's Response

There was a diagram showing the actual (current) implementation of the student class.

image.png

The diagram quoted by the tester was simply a suggestion of an alternative, that was created earlier in the development process. It should not hinder existing developers.

Future iterations can provide more alternatives with the newer class fields.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: As per the DG, the diagram quoted is "a more OOP version" of the (current) version. There was no mention that the quoted was simply an alternative created in the development process. Furthermore, as per the course website, aim of DG is to explain the implementation to a future developer, not an existing one.

Screenshot 2024-11-19 at 1.46.55 PM.png

As a new developer, there would be no way to know which diagram is correct and would be very confused, and would be forced to dive into the source code to check which diagram is the correct one.

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** As a new developer, there would be no way to know which diagram is correct and would be very confused, and would be forced to dive into the source code to check which diagram is the correct one. This greatly affects the consistency. Given that diagrams may not be updated, the reader is forced to check other diagrams as they could no longer be trusted.