search

nus-cs2103-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Command examples are too lengthy and complicated to understand #1977

Open nus-pe-bot opened 2 years ago

nus-pe-bot commented 2 years ago

Examples should be broken down so it is simpler for newer users to understand what is going on

Screenshot 2022-11-11 at 4.19.57 PM.png

Such lengthy command examples may deter users from using product

[original: nus-cs2103-AY2223S1/pe-interim#2563] [original labels: severity.Medium type.DocumentationBug]

wweqg commented 2 years ago

Team's Response

Clarification

Hello, thanks for raising this issue. We are fully aware that examples of some command can be lengthy and need some time to understand (add a buyer with two orders and add a supplier with two pets, to be specific). That is the reason why we include the color-coded version of these commands in our UG, as you can see in the screenshots below. This will help the users understand what these commands mean more easily.

Screenshot

image.png

image.png

More clarification

Furthermore, we stated in the UG that inexperienced users are encouraged to use the add command with a popup window, so this part is meant for more advanced users, as given below.

image.png

As explained in the user guide and the developer guide, chaining multiple commands to get a long complicated command in one shot is an optional bonus for those who are familiar with the operations. For other fast typists who are reluctant to understand it or key in many prefixes, then can choose to enter the commands one by one instead of chaining them together. Alternatively, they can use the pop-up window, too, which does not require users to type any prefix at all.

We also left enough hints and advice to readers that if they are not comfortable with these prefixes, and can try the pop-up window that does not require prefixes. We even provided them with a link directly to the section on how to use the pop-up window.

image.png

image.png

Reasons for lowering the severity

Some readers can understand the add command. Some may love it and stick to it. For those who are not comfortable with it, we have provided them with enough visuals to aid our explanation, and hints about other alternatives. We believe that even if this is really a bug, only a small portion of users will be truly affected, so it is a bug of low severity.

Reasons for it being a duplicate of another bug report

They are all about how difficult it is to understand the add-related commands and its sample commands in UG.

Thank you again and have a nice day!

Duplicate status (if any):

Duplicate of #305