nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Missing : in Architecture UML diagram for DG #1375

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.


image.png

They align with the standards outlined by the cs2113 course, the : symbol should be added in front of the class names to indicate that it is objects of the respective classes interacting architecture UML diagram


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

dextboy commented 7 months ago

Team's Response

It is mentioned that "Architecture diagrams are free-form diagrams. There is no universally adopted standard notation for architecture diagrams. Any symbols that reasonably describe the architecture may be used.". Furthermore, for the DG deliverable it is mentioned that "Design: similar to AB3 DG". The AB3 DG Architectural diagram does not have the ':' symbol in front of the class names, thus while I appreciate the diligence of aligning with cs2113 standards, this issue is rejected for the aforementioned reasons.

See: "Architecture diagrams are free-form diagrams. There is no universally adopted standard notation for architecture diagrams. Any symbols that reasonably describe the architecture may be used." below

Screenshot 2024-04-20 at 2.58.15 PM.png

See: "Design: similar to AB3 DG" below

Screenshot 2024-04-20 at 3.00.35 PM.png

Duplicate status (if any):

--