azriellee / pe

0 stars 0 forks source link

Flow of UG is unnatural #16

Open azriellee opened 1 year ago

azriellee commented 1 year ago

the UG starts with view, however initially there is nothing to view. A suggestion would be to start with the help command, then the command to update information, before viewing the information, which helps guide readers better. help command also missing from the UG. Other parts that were unnatural was the placement of list exercise before adding exercises were even introduced This affects the understanding users will have on how to use the program quite severely, and will cause confusion.

nus-se-script commented 1 year ago

Team's Response

The flow is based on what we thought was coherent however we understand that different people have different points of view.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I understand that different people may have different preferences as well. However there should still be some logical flow to things to aid users' understanding and user experience of the software and user guide.


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** The structure of the UG did in fact hinder my understanding of the user guide. 1. The first issue i had was that the "help" command was not even mentioned in the user guide, and only shown in the app itself. 2. Starting with "View User Profile", I immediately started using these commands and testing out. However as none of the commands returned any information, I realised that i had to first update user info, which is in the next section. If clear sectioning was used, both of these features could be grouped under "User Profile", with at least "updating user profile" being in front of "view user profile". For this current implementation, I struggle to understand how this way could be more coherent. 3. Next section explains "adding a mea", and one of the flags to input is "foods". However it is not clear what kind of food i can input, or whether i could type anything. This had to be inferred by the user who will first maybe randomly type in a food (e.g. rice) and a list of food related to it will be shown. The following section then talks about "Listing foods" which will show users all the food in the current database. Maybe the list of food should be shown before the add command, such that users will have a better idea of how to use the add command's flags 4. "Listing exercises" is also shown quite early on, before users are even introduced to what an exercise is or how to add exercises. These are just some of the examples of the issues i faced with the structure of the UG, which clearly shows how severely it hindered my understanding and testing of the app. Thus I strongly believe this is of severity "Medium".