search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Overly complicated Sequence Diagram #699

Open nus-pe-bot opened 2 months ago

nus-pe-bot commented 2 months ago

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.

The following Sequence Diagram is overly complicated and may cause readers to be confused.

image.png

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 ListAction command, NewCommand, etc Feature diagrams to keep things simple, as suggested on the CS2113 Wesbite

image.png

image.png

[original: nus-cs2113-AY2324S2/pe-interim#639] [original labels: severity.Medium type.DocumentationBug]

NgYaoDong 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

Duplicate status (if any):

--