Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Long sequence diagram of Graphic component is not readable #22

Open
rizemon opened this issue Nov 12, 2021 · 1 comment
Open

Long sequence diagram of Graphic component is not readable #22

rizemon opened this issue Nov 12, 2021 · 1 comment

Comments

@rizemon
Copy link
Owner

rizemon commented Nov 12, 2021

image.png

Aside from having very small text and making it hard to read, the sequence diagram was broken into 2 pages, thus the readers will have a hard time interpreting it. Perhaps it could be broken down into smaller components and using ref boxes.

@nus-se-bot
Copy link

nus-se-bot commented Nov 16, 2021

Team's Response

No details provided by team.

The 'Original' Bug

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

Complexity of sequence diagrams in DG

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

Some diagrams in the DG like the one shown above are rather large. Perhaps the usage of ref frames as seen here would help breaking down complex diagrams if stuff like certain method calls have to be shown.

Another instance of sequence diagram with a lot of self invocations which makes the diagram very long:

image.png

Once again the use of ref frames could be considered to improve readability.


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

Their Response to the 'Original' Bug

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

We believe that the first diagram is fine as it is. Enough detail must be given for a diagram to serve its proper purpose. We do agree though that the second diagram is a little too long and could be broken down into smaller parts.

Items for the Tester to Verify

❓ Issue duplicate status

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

  • I disagree

Reason for disagreement: [replace this with your explanation]


❓ Issue severity

Team chose [severity.VeryLow]
Originally [severity.Medium]

  • I disagree

Reason for disagreement: [replace this with your explanation]


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants