nus-se-bot
commented
6 months ago Team's Response
The class and sequence diagram is shown at the top of 'Design / Implementation' section of the DG. It's not missing. An argument can be made that each component should get separate diagrams for easy viewing, but that's not in the scope of this issue.
We don't consider the explanations to be way too long, because some members of the Record component like the problem set ID, problem set type etc. Can be confusing to software engineers in terms of its logic and purpose. The Record component especially so in this regard which is why this section gives more explanations on the justification and the details of its implementation that simply cannot be conveyed through a class or sequence diagram. Examples are "why are there two separate constructors", "why does the print method outputs different formats when the speed is 0", "In what format is each record saved to external files so I can safely edit them for testing without breaking it" etc. These are questions that developers would like to have answered and these sections, albeit lengthy, does just that.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
Missing sequence diagram and class diagram.
Explanation is way too long and can be simplified with the help of diagrams.