search

nus-cs2113-AY1920S2 / pe-dev-response

0 stars 0 forks source link

UI component lacks visual in DG #745

Open nus-pe-bot opened 4 years ago

nus-pe-bot commented 4 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.

The explanations of the TextUI interactions is good but a visual would have improved the clarity for me.

[original: nus-cs2113-AY1920S2/pe-interim#755]

lowxizhi commented 4 years ago

Team's Response

Thank you for your feedback. The use of visuals to explain the UI component in the Design section was deemed unnecessary and hence omitted by the developers because:

  1. The design of the UI component and its interactions with the 2 classes were simple, and did not require class diagrams/ sequence diagrams to be clearly understood.

  2. As the design of the UI component is not complicated, the section focused on the usability and functionality purpose the TextUI class served. Hence visuals and class diagrams/ sequence diagrams will not be helpful to the explanation.

Could you perhaps suggest what kind of visuals would have been helpful to aid understanding of this section?

Duplicate status (if any):

--