search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

[DG] Sequence Diagram too large #169

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.

It is difficult to read all the various commands, as well as the different functions that are being carried out in this one Sequence diagram. Perhaps using refs to break down this sequence diagram would be more useful to developers.

image.png

Some sequence diagrams are also overly long, being nearly one page long. Perhaps it would be better to split them into separate diagrams for better readability.

image.png

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

Mmaxx15 commented 5 months ago

Team's Response

agree but it is purely cosmetics

Duplicate status (if any):

--