soc-se-bot
commented
2 months ago Team's Response
Hi there, thank you for the report.
Appreciate the fact that you pointed out that the diagram might be too complicated. Unfortunately this was an unintended consequence, as our original intention was to reduce the amount of repetition in the Features section, and make this diagram an over-arching diagram for the general logic flow of all Commands in StockPal.
However, we would disagree that this is of Medium severity. Since the target audience of the Developer Guide is for developers, this diagram should be comprehensible enough for developers.
Regardless, we do appreciate your report, and thank you!
Best Regards, StockPal Team
Items for the Tester to Verify
:question: Issue severity
Team chose [severity.Low]
Originally [severity.Medium]
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
The following Sequence Diagram is overly complicated and may cause readers to be confused.
The sequence diagram is about the Command Feature. Since there are many different commands and permutations, the sequence diagram should be seperated to keep it simple. For example, it can be split into
ListActioncommand,NewCommand, etc Feature diagrams to keep things simple, as suggested on the CS2113 Wesbite