tlyi / pe

0 stars 0 forks source link

Storage component lacking elaboration #20

Open tlyi opened 3 years ago

tlyi commented 3 years ago

The sequence diagrams contains a lot of information but they were not explained properly. Some of the methods in the sequence diagram is not trivial, and more details could have been provided to explain the logic.

nus-se-script commented 3 years ago

Team's Response

"Some of the methods" is not very specific.

The logic for the storage is pretty simple but involves a lot of trivial interactions between different components. It would look very wordy if it was explained in words, which could be more confusing.

Items for the Tester to Verify

:question: Issue response

Team chose [response.IssueUnclear]

Reason for disagreement: The only explanation provided for this segment was this short paragraph, which did not explain much. Even if the logic is simple, the caption should still give a brief overview of the interactions.

In particular, I thought it would be important to elaborate more about the JSON API that the group used to convert the data to JSON objects. image.png


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]