nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Product name mismatch for error message #2871

Open nus-se-script opened 2 weeks ago

nus-se-script commented 2 weeks ago

When addCustomer who already exists, the error message says address book instead of BakeBuddy.

image.png


[original: nus-cs2103-AY2425S1/pe-interim#3922] [original labels: type.DocumentationBug severity.VeryLow]

bbryant824 commented 2 weeks ago

Team's Response

Since BakeBuddy is an addressbook product, it is indeed fine to call it addressbook. In fact, BakeBuddy is built on top of an addressbook, it extends from the basic addressbook function that contains contact information to include other features such as order and catalogue management, thus it is fine to call it address book.

And furthermore, since the person is added to the contact list which is the addressbook to begin with, we believe it is fine to name it addressbook and also, calling it addressbook also provides a clearer and more specific location of where we are referring to (the address book section on the right of UI) for the error message since Bakebuddy which is our app have many more areas to store information such as OrderLists in the middle section of UI and Catalogues not on the left when command prompts. Thus, using addressbook will inform the user better rather the just stating out our product name BakeBuddy.

Thus, we believe the bug stated here is not in out scope, because the usage of the word addressbook is fine and indeed, more specific and relevant for our context here as used in the error message. However, we recognise this error being pointed out here and will consider improving on it in the future such as making the error message more specific , for instance referring the location as "contact book of BakeBuddy" could be a more convincing way. But in our current version, we believe this usage of the word addressbook is fine, and the bug is not in scope.

Duplicate status (if any):

--