joytqt-1202 / pe

0 stars 0 forks source link

UML Sequence Diagrams in Developer Guide are too complicated #7

Open joytqt-1202 opened 1 year ago

joytqt-1202 commented 1 year ago

Sections Affected

Developer Guide - Implementation - Add Feature Developer Guide - Implementation - Find Feature Developer Guide - Implementation - Filter by price Feature

Description

The sequence diagram to illustrate the implementation of the features are too complicated, with too many low level details which resulted in the text size being very small and the diagram is hard to read without zooming.

An example is the add feature as shown:

image.png

nus-pe-script commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Cluttered diagram

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.


Too much 'low-level' information is being displayed here, resulting diagrams seems very cluttered and difficult to grasp. One way is to omit the different parsing of tags since the end result is just a recipe

Screenshot 2023-04-14 at 3.39.24 PM.png


[original: nus-cs2103-AY2223S2/pe-interim#1304] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

Cosmetic issue

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]