search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Diagram in DG does not follow what was taught in the course #477

Open nus-se-script opened 7 months ago

nus-se-script commented 7 months ago

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.

Description of problem: There are symbols/conventions used in the class diagram for the Find customer or order feature section of the Developer Guide.

Screenshot (if any): image.png

Rationale: VeryLow as this could be considered a cosmetic flaw since the explanation given under the diagram helps to explain. However, looking at the diagram itself, may not be readily understood what some things mean e.g A, C symbols used for the classes. This is assuming that readers are people who only know UML diagrams taught in CS2103/T.

Recommendation: Use PlantUML to adhere to CS2103/T standards.

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

chonghaoen commented 7 months ago

Team's Response

This is in fact the class diagram from PlantUML as per the recommendation.

Duplicate status (if any):

--