nus-pe-script
commented
6 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]
Lack of diagrams in implementation section
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.
Not enough visuals e.g., screenshots/diagrams
[original: nus-cs2103-AY2324S2/pe-interim#1756] [original labels: type.DocumentationBug severity.VeryLow]
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)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** I disagree. A big part of this course was learning to use UML diagrams to communicate to other developers how your features are implemented (couple weeks worth). I did not see a single one. None. I do not understand your implementation and it might've been easier for me to look at your code than to read your implementation in the developer guide. VeryLow is a cosmetic issue. Lacking UML diagrams (almost fully) is not a cosmetic issue at this point. I would have appreciated even 1 or 2 to explain the implementation.
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
AddandSave.The developer/reader would not have been able to understand how you implemented the features.
Screenshot