nus-pe-script
commented
2 years ago Team's Response
No details provided by team.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
No overall architectural diagram in DG
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.
DG jumps straight into separate functions without a brief overview and archi diagram for developers to refer to
[original: nus-cs2113-AY2122S1/pe-interim#1635] [original labels: severity.High type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
As stated in the course website, it is optional for us to use an overall diagram.
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 response
Team chose [response.Rejected]
- [ ] 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: Don't think this is a purely cosmetic issue as an overall design and architecture section can be quite useful to the developer in gaining a big picture view of the usage. I believe it should be more of low severity.
The design and implementation section immediately goes into descriptions of each component, class and functionality. It will be good to first have an overall high level architecture diagram and introduction + brief overview of the various components/classes and how they fit together as a cohesive whole.