search

AmeliaTYR / pe

0 stars 0 forks source link

UG hard to understand #20

Open AmeliaTYR opened 3 years ago

AmeliaTYR commented 3 years ago

Many commands seemed to rely on data the user needs to enter with other commands, but it is a bit unclear which commands the user can user on from the beginning.

eg

image.png

nus-pe-bot commented 3 years ago

Team's Response

Sorry, I do not understand what difficulties you are facing. all our commands are interlinked with each other. For example, only after adding a food entry then the list will reflect that added food entry. In that case, the list command would rely on data from add command. Similarly, it is only after you have created a set then you can add a set. Here are some indications/guides to use createSet before addSet:



  1. It was mentioned in the user guide to only add the shortcut after creating it.

    Screenshot 2020-11-15 at 6.48.12 PM.png


  1. Create Shortcut is before Add Shortcut for section 2.0 so that new users reading from top to bottom can get a flow of the ordering.

Screenshot 2020-11-15 at 6.54.26 PM.png

Screenshot 2020-11-15 at 6.54.12 PM.png

Screenshot 2020-11-15 at 6.54.39 PM.png


  1. To firther aid in first time usuability, the examples given in createSet and addSet are related, such that examples provided can be copied-paste into the CLI and results can be immediately observed without first time users having to infer and come up with examples by themselves. Afterwards, when they are more familiar with how to use shortcuts, they can come up with their own shortcuts.

Screenshot 2020-11-15 at 6.58.39 PM.png

Screenshot 2020-11-15 at 6.58.50 PM.png


  1. Even in the command summary, the createSet and addSet examples are related and strategically placed one before another.

image.png


  1. Since shortcut named "morning routine" was not shown to have been created, add set "morning routine" would not work as observed.


  1. Lastly, the resultant error message clearly shows that the shortcut, "morning routine", you are attemping to add has not been created and is asking for you to create it first.




I hope this clarifies any doubts you may have.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Since the commands are interlinked, and using them out of order causes them to be invalid, I would suggest that a flow chart or some visual explanation be added to demonstrate the user the order of commands to be used, especially since the starting commands are not highlighted in the command table, and the user cannot simply try out the commands at random.

Minimally it should be indicated which commands are immediately avaliable when the user first uses the program. Alternatively, since the commands are linked, they could simply be combined into a few long commands that take in multiple arguments rather than separating them, which would have more suitably satisfied the fast typist requirement of this project.

Thus the issue should not have been rejected as it impedes the use and testing of the app.