search

YHWong20 / pe

0 stars 0 forks source link

Overall sequence diagram is complicated and hard to understand #13

Open YHWong20 opened 1 month ago

YHWong20 commented 1 month ago

image.png

nus-se-script commented 3 weeks ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Class diagram is too large and complicated

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

You can consider omitting the specific details and functions names, but show how the classes actually interact with one another, using mainly arrows and labels.

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

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

nice suggestion, surely diagram for each class will make the architecture more clear and readable

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: I do not agree with the duplicate status.

The parent issue is related to the over-complicated nature of the UML class diagram.

Meanwhile, this issue is related to the over-complicated nature of the UML sequence diagram.

I apologize for not providing adequate details in my initial bug report. Hence, I would like to briefly state my reasons for flagging this issue as a separate bug.

This overall sequence diagram is over-complicated, as it has too many fine details due to its attempt to display the entire sequence of the application. It therefore becomes hard to understand the flow of events in the diagram, as well as the fact that it does not significantly showcase the individual components of the application.

I understand that the descriptions of individual components are detailed in the latter half of the DG. However, for visualization purposes, it is not easy to cross reference the descriptions with the diagram provided, and it is not easy to see which parts of the diagram are meant to represent the sequence for a specific component.

Therefore, this thus poses a hindrance for the reader, as they will need to make a significant amount of effort to read and understand the diagram provided.