Lack of Sequence Diagrams in Implementation Section of DG

[itsmejr257]

Within the Implementation section, there appears to be a lack of sequence diagrams for all of the features except file management. I believe it would be good to explain what methods are invoked and called by the classes represented to be able to follow the flow of code easier. Currently without any sequence diagrams, i am only aware of what classes are invoked, but i am unable to follow what methods are being used for each feature.

[nus-se-script]

Team's Response

Thank you for the feedback!

We have the sequence diagrams required for necessary features but we put them in the Design section. To prevent redundancy, these diagrams were not replicated in the Implementation section. This layout decision may have led to the perception of their absence. We acknowledge putting the sequence diagrams in Implementation section could be clearer and will address the navigational ease in our documentation. However, given that the information is complete but located in a different section, we would like to adjust the issue's severity to VeryLow.

For MiniGame - TypingGame, Tic tac toe, Hangman and TrueFalse feature, we have:

• This diagram explains the design implementation details of these features as the method invocation of MiniGames are similar.

For Stock, Bond, Crypto feature, we have:

• This diagram explains the design implementation details of these features as the method invocation of Stock, Bond and Crypto are similar.

For Company Management and RandomEvent feature, since the logic and invocation of the method are relatively simple. Therefore, we omit the diagram and use words to explain the implementation details.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.High]

• [ ] I disagree

Reason for disagreement: [replace this with your explanation]

---