Bencotti / pe

0 stars 0 forks source link

No legend for architecture diagrams in DG #9

Open Bencotti opened 4 years ago

Bencotti commented 4 years ago

Although there is no fixed formatting used for architecture diagrams, it would be helpful for new developers if there are legends for the types of arrows used to avoid confusion.

8.png

nus-pe-bot commented 4 years ago

Team's Response

It is expected of the developer to learn how to understand an architecture diagram before reading the DG. Moreover, the legend is not included in AddressBook Level3 as well.

Nevertheless, thank you for your suggestion.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Thank you for your reply.

Although it is not in the addressbook, an architecture diagram does not have any standardisations as with UML notation for class, object or sequence diagrams - which can cause misunderstanding if understood differently.

Is the purpose of the DG not meant to make it easier for future developers to understand the program better?


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]