Too many details in diagram

[CraveToCode]

In the diagram below, too many details and components working together are shown. Diagram becomes messy and hard to read in the process. An activity diagram would have been better to show the workflow in how each task's contact set is updated.

[nus-pe-bot]

Team's Response

An activity diagram is not as suitable to show explicitly the creation of the new objects, the Set of Contacts and the Task copy, which are crucial in the explanations. As such, a sequence diagram was used instead.

This sequence diagram was already a reference from a previous diagram and was meant to increase its readability. This diagram is also not as complex as it seems, only looking so due to the presence of alt and loop. If seen carefully, only 5 (6 including both if/else) method calls were actually done within this diagram. All of them are from the activation bar of ModelManager, so it should not be too hard to follow as claimed.

Items for the Tester to Verify

❓ Issue response

Team chose [response.Rejected]

• I disagree

Reason for disagreement: 3 different components (Logic, Model, and an unspecified component) are involved in this sequence diagram that explains how a simple updating of contacts is carried out. That itself makes the sequence diagram unnecessarily complex for a simple update operation. The user does not need to know low level details such as a new Hashset<>() being created.

There is also a statement Create copy of originalTask with updatedContacts which is used as a label pointing to newCopy:Task. Such syntax is not normal for sequence diagrams, as a method call is expected here.

The usage of such notations is also why I recommended an activity diagram might be more suitable. An activity diagram will help abstract away unnecessary low-level information such as creation of a hashset, and will also enable you to use phrases such as Create copy of originalTask with updatedContacts in action boxes. It is sufficient for the developer to know what the workflow is when a Task's contact set is being updated, which is the objective here. An activity diagram is better suited for this. Low-level details do not value add.

---