dillontkh
commented
5 months ago Team's Response
The purpose of the UML diagram above is to assist the reader in understanding the Model component of FitBook. While we agree it would be ideal to have all the attributes of a Person in the diagram, we think that the omission of a few Person attributes would not hinder the reader from the intended purpose of the diagram, which is to show the inner workings of the Model component.
Definition of a High severity bug: A flaw that affects most users and causes major problems for users.i.e., makes the product almost unusable for most users.
Our team believes that this bug would be a High severity documentation bug only if it would result in the reader to be completely misinformed about the Model component, causing the diagram to be almost unusable for most readers. (e.g. by having completely incorrect multiplicity labels)
We think a fairer severity of this bug would be Low as the Height and Weight attributes are mentioned and explained in their relevant areas. In this specific diagram, we think the omission of those attributes would only be a minor inconvenience to the reader.
A possible improvement would be to add a note clearly explaining the omission of such nitty-gritty details. (e.g. Not all attributes of a Person are shown)
As such, we have accepted the bug but reduced the severity from High --> Low.
Duplicate status (if any):
--
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.
The person model in your repo seems to have some other associated attributes/classes such as Height, Weight. This is not properly reflected in the UML diagram. Given below.
Will be elevating this to high since it seems to be quite a large oversight.
[original: nus-cs2103-AY2324S2/pe-interim#2497] [original labels: type.DocumentationBug severity.High]