search

filbertphang / pe

0 stars 0 forks source link

UG/DG: Inconsistent naming of app #15

Open filbertphang opened 1 year ago

filbertphang commented 1 year ago

The app is referred to in multiple places as multiple things: Advis.io, AIO, AddressBook, ClientBook, etc

soc-se-bot commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

UG still refers to the application as AddressBook

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

image.png

Traces of AddressBook is still present.

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

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

The user guide is for users without technical background. Based on the definition on google, AddressBook is used for storing entries of names, addresses, basically personal contacts. Hence, the user should know what is the address book storing based on definition, which is the personal contact of the people that the user adds into the application.

Based on the developer guide which is for a different target audience, we have address the definition of address book to developers so they know what AddressBook does. There is a greater need to define the AddressBook in Developer Guide than in User Guide.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

## :question: Issue response Team chose [`response.Rejected`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]