search

Hibeom0929 / pe

0 stars 0 forks source link

Explanation for archiving is needed. #14

Open Hibeom0929 opened 2 months ago

Hibeom0929 commented 2 months ago

I'm not sure about the purpose of archiving in the context of managing contacts and reservations in my restaurant. It would be better to have explanation of why we need it with some examples in UG.

nus-pe-bot commented 2 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Lack of descriptions on archived list on UG

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

There is no information in the user guide about what an archived list is, or what it is used for. Since there is no difference between an archived list and contact list, users will not understand the need to archive lists.

[original: nus-cs2103-AY2324S2/pe-interim#5572] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

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

The archive feature is self-explanatory, as it simply archives or hides a contact from the contacts list, by placing the archived contact into the archived list.

Putting the purpose of a feature in the UG is not very necessary, as the user can decide for themselves how to use the feature. We have also clearly stated the functionality of the feature.

Furthermore, we also have user stories for archiving and unarchiving contacts, with the context of contracts expiring. This provides the user with possible benefits of this feature.

image.png

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:** Use cases in DG may not be helpful for users as that is a 'Developer" guide and normal users may not open that file. Also, the description in UG is only about the functional result of the command and the archive has no difference from the normal address book. So, users may not have an idea how and why to use it. Thus, it would be better to have specific examples to show what users can do with the archive in UG.