search

a1021492980 / pe

0 stars 0 forks source link

The sequence diagrams in the DG is not of a standardized form #20

Open a1021492980 opened 2 years ago

a1021492980 commented 2 years ago

image.png

image.png

There are 2 different styles of sequence diagrams in the DG, standardized to only 1 style would be better.

nus-pe-script commented 2 years ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Non-standardized color scheme between different 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.

The usage of colors in the diagrams are different between certain diagrams which may indicate to the reader that they are not referring to the same object.

The colors for each object should be standardized across diagrams.

image.png

image.png

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

Their Response to the 'Original' Bug

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

Think this is very minor. Even if we were to standardise the colour scheme, a user would have to read the diagram closely to know that we are referring to a particular object.

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]

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The DG should be written in a way such that it looks like one person's work.

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]