gavingoh99 / pe

0 stars 0 forks source link

Lingering references to address book #10

Open gavingoh99 opened 6 months ago

gavingoh99 commented 6 months ago

In the UG, the new user tutorial provides an introduction to the UI, specifying that the GUI with the contacts will henceforth be referred to as clients list:

Screenshot 2024-04-19 at 5.22.08 PM.png

However, there still remains references to address book likely from adapting the UG / DG from AB3 which can in turn lead to confusion on the user's end!

Screenshot 2024-04-19 at 5.23.25 PM.png Screenshot 2024-04-19 at 5.23.37 PM.png

nus-pe-bot commented 6 months ago

Team's Response

'Clients List' is a UI component, 'Address Book' is referring to our application as a whole.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Thanks for providing the distinction. However, given that this fact is only made known through your response, would it be better if address book were to be officially defined in the relevant documentation (UG & DG) to prevent confusion on the user's end? In this case, I don't think we should assume that users will have a working understanding of what the address book refers to. Of course, we as students of CS2103/T, will automatically associate address book with the application given that we have worked on it as a brownfield project. However, the same cannot be said about users reading the documentation.

In this case, I still feel that it is better to err on the side of caution and simply lay it out for users at the very start, thus eliminating the possibility of confusion.


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]