search

joshualeejunyi / pe

0 stars 0 forks source link

Sequence Diagram in Developer Guide does not flow well #12

Open joshualeejunyi opened 7 months ago

joshualeejunyi commented 7 months ago

Description: The sequence diagram on page 4 of the Developer Guide does not flow well and would confuse developers who are reading this for the first time.

As seen in the screenshot below, Parser -> Command, 4 Execute, I assume the Parser calls the execute method in Command, however, it shows that Command->Storage 5 Save Logs to File afterwards.

The next line is then Parser->Scanner for the input, and does not show if the Storage returns to Command, which then returns to the Parser.

Editing to add the second diagram below, under Log Package, which is very hard to follow.

Screenshot:

image.png

image.png

nus-se-bot commented 6 months ago

Team's Response

No details provided by team.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.Low] Originally [severity.Medium]

Reason for disagreement: Sequence diagrams are meant to help future developers have a clearer understanding of the project, and thus I believe this should still be Medium as it sort of defeats the point of the sequence diagrams.