search

CJun1039 / pe

0 stars 0 forks source link

Developer guide uses unknown terms. #6

Open CJun1039 opened 1 year ago

CJun1039 commented 1 year ago

Developer guide uses AddressBookParser in the diagrams and explanation.

Checked the source code to find that the team is indeed using AddressBookParser in their code.

However, may confuse the developer as to what "AddressBook" is.

Screenshots:

image.png

image.png

nus-se-bot commented 1 year ago

Team's Response

AddressBook is a common term used in the entire DG to refer to the component of CLInkedIn. CLInkedIn is also an example of an addressbook. Hence, we decided not to refactor the name of the AddressBookParser class and other classes, and this shouldn't be a source of any confusion for the developers. Hence, we feel that this is an invalid bug.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: If addressBook is a common term, it should have been explained in the glossary, at least.

It is also not stated as a component under the component section. Furthermore, there is no explanation inside the DG as to what an addressBook is in the context of CLInkedIn.

Also, i feel that if CLInkedIn is an example of an addressbook, using addressbook as a component of CLInkedIn adds to the confusion.