search

ngnigel99 / pe

0 stars 0 forks source link

Redundancy of icon in architecture diagram (DG) #17

Open ngnigel99 opened 3 years ago

ngnigel99 commented 3 years ago

Not too sure what Commons here is for, as it has no relationship with the other attributes

image.png

It's claimed to represent a collection of classes, but it's still not really defined in the project scope. Perhaps more elaboration could be included image.png

edit: wow it actually contains a lot of information. Consider elaborating and adding a hyperlink to it to value add to the architecture diagram.

nus-se-script commented 3 years ago

Team's Response

The Commons package is used by almost all classes in our program, we decided to omit any arrow from our diagram to avoid cluttering.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Agree with your (short) response as I mentioned it in my edit - however, following your response I think it would better to create another diagram to explain the interaction between Commons and your classes as it's a really important utility package.

For instance, Commons contains the information related to Command format, which seems to hold constants,

image.png

which is later used by Parser as a core feature

image.png

Thus, there's a lot of missing and important information for fellow developers that's not reflected simply by claiming that

image.png

:question: Issue severity

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

Reason for disagreement: Missing key details of Commons, which is useful for new developers on the team - the DG should communicate important information such as the details of the Commons package.