Rye98 / pe

0 stars 0 forks source link

Descriptions are too brief (DG) #18

Open Rye98 opened 3 years ago

Rye98 commented 3 years ago

More information can be provided for many parts of the DG. For example, what does each class do, and how does the classes interact with one another on a smaller scale, instead of simply providing a short overall process. (The current implementation does not provide enough necessary information to people who may wish to continue enhancing on this application)

image.png

image.png

nus-pe-bot commented 3 years ago

Team's Response

Similar issues.

The 'Original' Bug

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

UML Diagram too long and complex

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.


Should the UML diagram focus on smaller sections of the functionalities? e.g. 1 UML diagram for booking movies, 1 UML diagram for adding reviews etc rather than having 1 gigantic UML diagram for all commands that the customer can use? Screenshot 2021-04-16 at 5.30.07 PM.png


[original: nus-cs2113-AY2021S2/pe-interim#487] [original labels: severity.High type.DocumentationBug]

Their Response to the 'Original' Bug

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

Thank you for the suggestion. We agree that it would be good to provide further detailed explanation on each section.

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 severity

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

Reason for disagreement: [replace this with your explanation]