adam-ky / pe

0 stars 0 forks source link

[DG] Details too small for Sequence Diagram of DeletePersonCommand #17

Open adam-ky opened 2 years ago

adam-ky commented 2 years ago

Generally not much of an issue, simply a cosmetic issue.

image.png

nus-pe-bot commented 2 years ago

Team's Response

The diagram has already taken up the entire width of the page and is the same size as all the other diagrams. The diagram is not cluttered, the font size is not too small and is readable.

Also, when viewed through a device, you are able to zoom in on the diagram to view the details however you are comfortable with.

Since all the details in the diagram are necessary, we reject this bug.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I quite disagree that all the details in this sequence diagram are necessary. The useful and informative part of this sequence diagram is the loop part which illustrates the removal of all module codes linked to the person. However, that part of the sequence diagram became so small because of the other details involving the Parser-related classes.

Furthermore, the interactions between Parser-related classes have already been illustrated several times in the sequence and architecture diagrams presented earlier in the DG. I suggest you can simply abstract out the interactions between Parser-related classes instead of showing it in all sequence diagrams for your implementations (under the Implementation section of DG) to reduce the clutter.

Additionally, the back and forth tracing of the interactions between ConthacksParser, DeletePersonCommandParser and DeletePersonCommand was tedious and not very helpful to support your explanation for the implementation design of batch delete.

Lastly, your suggestion to zoom in is not reader-friendly as it is not their problem whether they need to zoom in or not. At the time of reporting this issue, I was using a 32-inch screen and the details in the default window size were quite small for me already.

On a side note, as shown in the guideline below, having small details is usually a symptom of having too many details, which I have explained above.

image.png