search

KohGuanZeh / pe

0 stars 0 forks source link

Better referencing using `sd` frames #11

Open KohGuanZeh opened 2 months ago

KohGuanZeh commented 2 months ago

I think the sequence diagrams with the factory method can be replaced with an SD frame that states how the component works instead.

image.png

It can be confusing to use a fictitious method and how the 2 diagrams relate to each other. I think an SD frame would be more appropriate here, together with other diagrams that has the same issue.

nus-se-script commented 2 months ago

Team's Response

Thanks for the suggestion, but we believed that this was the better approach for the following reasons:

  1. The ref frame would require the CommandType, t:CommandType and DeleteCommandto be included in the first diagram still, as per the course material below. This would lead to a very wide and "zoomed out" sequence diagram and hinders the reader.

image.png

  1. We find Prof's suggestion of using a fictitious method to be clearer to the reader. We also clearly specified that the second sequence diagram is the description of the fictitious method.

image.png

Therefore we believe that within the context of v1.4, this is not in scope.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [replace this with your explanation]