tobihy / pe

0 stars 0 forks source link

Inconsistent colour themes of sequence diagrams #11

Open tobihy opened 2 years ago

tobihy commented 2 years ago

In the developer guide, some of the UML sequence diagrams have inconsistent colour themes.

Screenshot 2022-04-16 at 3.20.39 PM.png Screenshot 2022-04-16 at 3.20.44 PM.png

This can potentially mislead users into thinking that one of the diagrams are of a different type/has something special as compared to the other. It also affects readability of the DG, as the reader would be confused as to which colour scheme he/she should expect in the other sections.

nus-pe-script commented 2 years ago

Team's Response

Duplication of #1656. Does not affect user's understanding of the diagram.

The 'Original' Bug

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

Inconsistent colour themes of activity diagrams

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.


For activity diagrams, some of them have different colour themes from the other ones.

Screenshot 2022-04-16 at 3.27.45 PM.png Screenshot 2022-04-16 at 3.27.39 PM.png

This can cause confusion to the reader, since only a few of the activity diagrams seem to have a different colour scheme, while the majority of them have the same colour scheme.


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

Their Response to the 'Original' Bug

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

Does not affect reader's understanding of the diagram.

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: It is a different type of diagram (activity diagram vs sequence diagram), and the issue cannot be fixed together.


:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: It is a color issue that does not affect usage, which is considered severity.veryLow as mentioned on the CS2103T module website.

image.pngScreenshot 2022-04-20 at 2.33.24 PM