search

delishad21 / pe

0 stars 0 forks source link

UML class diagram under Model component do not show the 'Department` class #20

Open delishad21 opened 4 months ago

delishad21 commented 4 months ago

image.png

The person code clearly contains the department class. The omission is not very justifiable as well as Department seems to be an important attribute in the context of your application. Furthermore, the department class is even more important to include as it optional which differs from how the rest of the classes in Person behaves

nus-se-script commented 4 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]

Model UML Diagram does not include Department

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.

image.png

image.png

Model UML Diagram does not include Department which is a vital component for a Person model.

[original: nus-cs2103-AY2324S2/pe-interim#501] [original labels: severity.Medium 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.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** As mentioned in my original report, > The omission is not very justifiable as well as Department seems to be an important attribute in the context of your application. Furthermore, the department class is even more important to include as it optional which differs from how the rest of the classes in Person behaves The team has failed to elaborate on why they believe that this omission is not deserving of the `severity.Medium` label. The department is a key feature of your application, as outlined in your value proposition and user stories. This issue may have been lower severity if the department feature was elaborated upon elsewhere in the document. However, a quick search in their DG indicates that the only sections in which the term 'department' is used are in the value proposition, user stories and planned enhancements. All of which do not contain a single bit of implementation detail about Department. An easy way to have documented the use of the department class would have been to add it under this Model UML diagram, where the multiplicity of the 'Department' contained in `Person` could have been easily indicated (as 0..1) to allow developers to understand that "A person may or may not be part of a department". Due to the lack of any information regarding the `Department` class anywhere else in their documentation, the omission of `department` from this UML diagram results in a large gap in documentation with regards to the `Department` class and would have caused more than the occasional inconvenience to the readers of the developer guide as they would be lacking crucial information. Making this issue very much deserving of the `severity.Medium` label.