Open itsmejr257 opened 4 months ago
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
.MiniGame
- TypingGame
, Tic tac toe
, Hangman
and TrueFalse
feature, we have:MiniGames
are similar.Stock
, Bond
, Crypto
feature, we have:Stock
, Bond
and Crypto
are similar.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.Team chose [severity.VeryLow
]
Originally [severity.High
]
Reason for disagreement: [replace this with your explanation]
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.