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.
Overview
It would be ok if not all your implementation/features had UML diagrams to support the developer. However, there were none to be seen (apart from those already in AddressBook3).
There were only two features documented (with barely enough depth) and those were Add and Save.
The developer/reader would not have been able to understand how you implemented the features.
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.
Overview It would be ok if not all your implementation/features had UML diagrams to support the developer. However, there were none to be seen (apart from those already in AddressBook3).
There were only two features documented (with barely enough depth) and those were
Add
andSave
.The developer/reader would not have been able to understand how you implemented the features.
Screenshot
[original: nus-cs2103-AY2324S2/pe-interim#4132] [original labels: severity.Medium type.DocumentationBug]