MaYuehan / pe

0 stars 0 forks source link

Edit command format in UG #6

Open MaYuehan opened 5 months ago

MaYuehan commented 5 months ago

The example in the UG of the edit command only show how it can edit the name and tag, however the exception message shows that the fields such as phone, email, address can all be edited. This can make confusion that only the name and tags can be edited when viewing the new user tutorial.

I find the details in the feature section. it is better to state that all the details will included in the feature section between tell the new user to go to the new user tutorial.

Screenshot 2024-04-19 at 4.49.45 PM.png

Screenshot 2024-04-19 at 4.51.46 PM.png

nus-pe-bot commented 5 months ago

Team's Response

Our new user tutorial was meant to take a new user through basic features and commands of our application. Hence, examples were given as that was what we wanted users to focus on. Attached is a screenshot of our statement about the purpose of our new user tutorial, as well as stating clearly that full details can be found in the features list:

3C3D1AA0-0BA1-4905-947C-A2294AC50F28.png

We included a more detailed description of each command after the new user tutorial (the features section) which was meant for the user to go through after seeing / experiencing a quick demonstration.

New user tutorial and features section were not meant to serve the same purpose.

Additionally, users can use the home button to jump back to the first page, with the table of contents right after that. The table of contents contains the links to all commands in the features section, with more details, including the official format requested.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]


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