search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Inappropriate use of sequence diagram #3358

Open nus-se-script opened 6 months ago

nus-se-script commented 6 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.

image.png

The sequences diagrams shown only contain one action, which defeats the purpose of a sequence diagram, which is supposed to show how the different components of a system interact with each other. One way to improve this diagram would be to "zoom" out and show this command in a larger context, so that we can see how the system interacts with each other.

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

shawnnlimm commented 6 months ago

Team's Response

The purpose of the sd frame is to ensure that the original diagram is large enough for the user to see it's details. If we do not use the sd frames to reference from the original diagram, elements in the diagram would be too small for the user to read.

Duplicate status (if any):

--