Ambiguity in Model Class Diagram

[nus-pe-bot]

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.

---

There are multiplicities given for Interest and Module, however, the lack of a multiplicity value for Github, Phone and Email objects gives the impression that those fields are not optional, as they have the same (none) multiplicity as the required Name and Telegram objects. But that's not the case in the actual program where a person's Github, Phone and Email could be null values.

---

_{[original: nus-cs2103-AY2223S1/pe-interim#501] [original labels: severity.Medium type.DocumentationBug]}

[carriezhengjr]

Team's Response

The tester categorised this issue as Medium but we feel that it should be Low, as whatever is shown is correct, but according to the tester is missing some information.

Furthermore, we feel that this issue is not a bug.

Multiplicities are optional, as seen from the module website which says "Association multiplicities and the default value can be shown as part of the attribute using the following notation. Both are optional". Hence, omitting them is fine.

Furthermore, although adding multiplicities for all the fields may provide the reader with more information, we feel that it will instead confuse them due to the excess information in one diagram. According to the DG Tips on module website, we were advised not to add too many details to the diagram. Therefore, we deliberately chose to add multiplicities to Interest and Module only to show that there exists a one-to-many relationship. As for the mandatory fields Name and Telegram as well as optional fields GitHub, Phone and Email, they are already stated very clearly in the UG. The command format that we have used are explained clearly under Take note of the Command Format.

Duplicate status (if any):

--