nus-cs2103-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Examples in UG are complicated #3622

Open nus-pe-bot opened 2 years ago

nus-pe-bot commented 2 years ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.


Screenshot 2022-11-11 at 5.15.52 PM.png

This snippet could be broken down so that is easier for users to read and comprehend There is too much going on for users to take in


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

wweqg commented 2 years ago

Team's Response

Dear Tester,

Thank you for your candid feedback, after looking into this issue we have decided that this is not a bug for two reasons. The first is that we have actually recommended users to use the pop-up window instead of directly keying in commands, so that it is less overwhelming for first-time users. For more advanced users, because of their familiarity of CLI, they would not have an issue with the lengthy commands. The second reason is that the add command is actually used this way, especially if you want to add multiple orders.

Screen Shot 2022-11-13 at 2.36.36 PM.png

All in all, it is not a feature flaw because of the Add-command pop-up window which allows users to escape the overwhelming commands, and this option of keying in everything into the command line should only be reserved for advanced users.

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, it is a cosmetic problem. Our layout, colour-coding, order of sections should be designed better. Hence, it is a bug of very 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