ZhangWenyue3325 / pe

0 stars 0 forks source link

Missing diagrams other than sequence diagram in DG #12

Open ZhangWenyue3325 opened 3 months ago

ZhangWenyue3325 commented 3 months ago

In DG, sequence diagrams are provided for basically every feature. However, only one class diagram is provided for Parser. As each of the features contains the interactions among many classes, more class diagrams to illustrate the features may be clearer and easier to understand.

nus-pe-script commented 3 months ago

Team's Response

Thank you for your observation.

We admit that we focused way more on doing Sequence diagrams that we managed to only provide one class diagram. This issue is a duplicate of #911 as they both raised the same issue of having missing diagrams.

The 'Original' Bug

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

Add different 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.


The DG currently has more sequence diagrams with one class diagram. Consider adding different diagrams like class and flow diagrams to increase the understandability of the product


[original: nus-cs2113-AY2324S2/pe-interim#834] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

Thank you for your observation.

We admit that we focused way more on doing Sequence diagrams that we managed to only provide one class 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: [replace this with your explanation]