search

Goh-Li-Ting / pe

0 stars 0 forks source link

Sequence diagrams are too small to read #18

Open Goh-Li-Ting opened 10 months ago

Goh-Li-Ting commented 10 months ago

Multiple sequence diagrams have small fonts that are difficult to read due to too many details included.

image.png

nus-pe-bot commented 10 months ago

Team's Response

The visibility of the diagrams will be rectified upon splitting the diagram into two components as mentioned in issue #1353.

The 'Original' Bug

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

DG: Undo sequence diagram shows internals of more than one main component

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.

According to prof, who stated in one of the issues on the Github forum, you should not show the internals of more than one main component - you should split it into two.

Screenshot 2023-11-17 at 5.33.30 PM.png

[original: nus-cs2103-AY2324S1/pe-interim#2018] [original labels: type.DocumentationBug severity.Medium]

Their Response to the 'Original' Bug

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

I accept this is a valid bug. However the severity of this issue should be Low instead of Medium as it does not cause inconvenience to the reader as they can still understand the diagram clearly and this issue is simply a design flaw where there is too much information included, and the diagram should be split up.

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: [replace this with your explanation]