search

nus-cs2103-AY1920S2 / pe-dev-response

0 stars 0 forks source link

UML Diagram for Logic #2302

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.

In the sequence diagram of the user guide in page 6. is is seen the the Logic access the sotrage to modify the file when the model is changed.

However, in the logic Class diagram, there is no pointer to the Storage class.

Also in the sequence diagram in the page 9, the interaction between logic and storage is not reflected

Screenshot 2020-04-17 at 3.29.34 PM.png Screenshot 2020-04-17 at 3.29.39 PM.png

[original: nus-cs2103-AY1920S2/pe-interim#2273]

J-Dan23 commented 4 years ago

Team's Response

Our Developer Guide aims to provide a comprehensible overview of the workings of our App.

The purpose of the Logic Component diagram is to give a clear overview of its relevant classes. Moreover, we included the Model Component as developers working on the Logic Component will interact very often with the Model component. In addition, the Storage component is not actively shown because it is largely fixed in functionality and developers are not expected to perform much change to it.

Furthermore, according to the CS2103T website, in "potential bugs of UML diagrams", the diagrams do not have to be overly comprehensive.

image.png

Severity (if any): low because this unlikely affects normal operation (if any)/brings minor inconvenience (if any). Note that this is explained despite us rejecting it, as the Github forum requires us to explain any changes to severity.

Duplicate status (if any):

--