search

nus-cs2103-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Sequence diagram in `Venue Command Flow` overly complicated, and too small at 100% scale #3000

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year 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 sequence diagram is overly complicated and too small. Readers have to squint their eyes or zoom in to see the details. The sequence diagram should have been split into 2 different diagrams, separating the execution and parsing concerns, as this is too much to swallow for a new developer reading the developer guide.

image.png

Supported by CS2103T website, 4th bullet point:

image.png

[original: nus-cs2103-AY2223S1/pe-interim#2532] [original labels: severity.VeryLow type.DocumentationBug]

nseah21 commented 1 year ago

Team's Response

We agree that the text in the diagram is too small, and that the diagram is overly complicated. Thank you for your suggestion to split the diagram up into two smaller diagrams, to separate the execution and parsing concerns.

Duplicate status (if any):

--