YuvBindal / pe

0 stars 0 forks source link

Flow of commands not coherent in the UG #12

Open YuvBindal opened 4 months ago

YuvBindal commented 4 months ago

The UG command summary does not give commands that are coherent with one another, for example,

Screenshot 2024-04-19 at 5.13.46 PM.png

If the commands are run sequentially, they would result in invalid errors as they are not coordinated. if the user runs the following command order:

  1. add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague b/01/01/2001 d/monday $/100

  2. clear

3.delete 3 -> invalid example as index 3 does not exist in the address book

  1. edit 2 n/James Lee e/jameslee@example.com -> invalid example as index 2 does not exist in the addressbook.

Perhaps, the team can reorganise the UG command summary for the ease of testing of the users and more organised command lines. Regards!

soc-pe-bot commented 4 months ago

Team's Response

The command summary is not meant to suggest to the reader to run the commands in any sequence. It is meant as a "cheat sheet" that users can refer to.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I believe if the team's interpretation of the summary command is a cheat sheet then it should be mentioned in the documentation. However, this still causes issues.

This is because a misarranged command summary causes inconvenience to new users that are not familar within the application and how different features blend together resulting in invalid commands as a sequence is not followed. It is the developer's job to ensure that the users understand the sequence of commands to follow to run the application and by arranging the command summary in a coherent manner this purpose can be simply achieved.

Usually, from the other UGs and DGs of other groups I have tested they had this coherency to ensure that the user/tester experience is smoother.