search

fahim-tazz / pe

0 stars 0 forks source link

Reference to AddressBook in Advis.io UG #8

Open fahim-tazz opened 1 year ago

fahim-tazz commented 1 year ago

In the UG Editing the data file section, there is a reference to AddressBook, which is not the software being presented.

image.png

nus-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`] - [x] I disagree **Reason for disagreement:** I could not find any technical jargon `AddressBook` (without the space in between). Based on my knowledge of our SE context, I can tell this is a leftover from the original AB3 DG. If you wanted to use `AddressBook` to refer to an application that tracks contact details, then maybe this should be reflected in some sort of glossary or parentheses.
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]