nus-tic4002-AY2122S2 / pe-dev-response

0 stars 0 forks source link

[TIC4002-F18-4] [v1.4] [Developer Guide] UML Diagram Suggestions #206

Open nus-se-bot opened 2 years ago

nus-se-bot commented 2 years 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.


I would suggest including attribute properties in your diagrams. This would much better convey the data/properties of a class/function during its instance.

example:

image.png


[original: nus-tic4002-AY2122s2/pe-interim#196] [original labels: severity.Low type.DocumentationBug]

TanChiaChun commented 2 years ago

Team's Response

Thanks for the suggestion, attribute properties are considered too much details, which is optional for the intended high-level class view.

Duplicate status (if any):

--