Berted / pe

0 stars 0 forks source link

DG: Sort Internships Feature sequence diagram is overly simplistic #18

Open Berted opened 1 year ago

Berted commented 1 year ago

Developers should already understand how the app is designed with its 4 distinct components (Logic, UI, Model, Storage) and how they interact with each other by this point in the guide.

I find that the diagram provided is too simplistic to provide any developers with insight into how the feature is actually implemented in code.

Albeit I find the description to be perfectly okay, nice work! Perhaps can incorporate some of the details of that description into the diagram itself.

nus-se-script commented 1 year ago

Team's Response

We feel that it still value add by showing how the list is updated to displayed the applications in sorted order. Otherwise, it may not be as clear which components are responsible for sorting the list and how it is updated.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I find that in its current state, it's still unclear how the application actually processes the query. While having a high-level overview is great, I don't see how this diagram adds a lot of value when diagrams like those on page 5 already show how a normal interaction is processed.

In addition, consider that this diagram is in the implementation section, where we should be focusing a bit more on specific details rather than another high-level overview.

As a potential developer, I find that having diagrams such as those on page 15 and 17 would be much clearer as to how the code actually processes the command.


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]