nus-se-bot
commented
2 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.Low`] - [x] I disagree **Reason for disagreement:** This should definitely not be classified as `severity.VeryLow`. The definition of it is "...typo/spacing/layout/color/font issues in the docs or the UI that doesn't affect usage". We can even see from the screenshot in the duplicate bug report, that there is already little to no information regarding the current implementation of the application. I feel that this might warrant an even higher severity, since there is little to no written and visual information for the user to see any of the features the team has implemented. I do not think that using the reason of their features being "the same as AB3" or "heavily inspired by the original AB3 code" discounts them from adding more diagrams or explanation regarding how their application works. There are definitely more diagram types like activity diagrams which is only used in a small portion in the proposed section of the original AB3 DG, that could be used to explain more of their implementation.
In the Implementation section of the DG (for existing implementations), there are no class/sequence/object/activity diagrams for us to visualise what the application is doing. Although the implementation might be similar to AB3, I think it would benefit from some additional diagrams that AB3 initially did not cover like activity diagrams. The current implementation is only explained by text, which might be hard for one to visualise the process of the application.