nus-cs2103-AY2122S2 / pe-dev-response

0 stars 0 forks source link

Possibly missing a helpful glossary term: User #2139

Open nus-pe-bot opened 2 years ago

nus-pe-bot commented 2 years ago

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.


In the UG I was confused by the command and purpose of setUser as I did not understand if this application was intended for different people to utilise at different times. From the UG you mentioned the product scope is to "keep track of not only your own, but also your friends’ schedules" which meant to me the only user of the app should be the person who has the software on his/her computer and only they themselves has access to their computer. If the setUser command is meant to show that multiple users will use the application on a shared computer at different times, I think it might be violating a project constraint:
"The product should be for a single user i.e. (not a multi-user product).
Not allowed: Application running in a shared computer and different people using it at different times. "

Screenshot 2022-04-16 at 3.12.12 PM.png

Thus, it might be helpful to readers to include within the UG a note or mention in the DG glossary the meaning/role of a User in this context.

Screenshot 2022-04-16 at 3.27.21 PM.png


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

vishandi commented 2 years ago

Team's Response

Your definition of a User is correct. The purpose of the setUser command is to let a user moves his/her contact to the top of the list, so you can see your person card easier. It is not meant for different users using the same UniGenda app. Think of this situation: you added your friends contact, then you forget to add your own contact. UniGenda allows you to move your contact to the top of the list to make it easier for you to see and view your schedule (as viewSchedule requires you to key in a person's index, and if your person card is at the bottom, you will find it really difficult to find it). In addition, User is neither a technical term nor used differently throughout the UG.

Duplicate status (if any):

--