search

zackjh / pe

0 stars 0 forks source link

Most commands are too long and/or hard to type #2

Open zackjh opened 1 week ago

zackjh commented 1 week ago

Description

Most commands contain two or three words which makes it difficult and time-consuming for the user to type.

The use of hyphens also make the commands harder to type.

This goes against the intended typing-focused use case of the application.

E.g. add-client, list-policies, list-expiring-policies

Having shorter commands, such as exppol instead of list-expiring-policies, would make the application more user-friendly as the users would not have to type such long commands.

Screenshot of Command List

I've attached a screenshot of the command list found in the UG for convenience.

command-list.png

soc-pe-bot commented 5 days ago

Team's Response

Thank you for your inputs! After carefully considering your suggestion, the team would like to politely reject it due to the following reasons:

  1. Our app is designed for fast typist so such minor differences in command length should not be significant.
  2. We felt that using the command words as provided by you could be less intuitive. Commands such as "exppol" is not immediately self-explanatory considering that there is no verb in the command word to tell the user what it does.
  3. We would like to have Prudy commands as similar to the english language as possible, considering the application will be used by non-technical users. Having the command words resemble english words will allow for a more gradual learning curve for using the application.
  4. Having the command words to resemble the english language allow users to "type what they have on their mind". For example, if the user thinks of "listing expiring policies", the user can simply type what is on their mind, making it easier to remember these commands, compared to consistently associating "listing expiring policies" with "exppol".

Furthermore, the team would like to highlight that the bug reported could be classified as a suggestion.

Regardless, we really appreciate the thoroughness of the bug report.

We have classified this bug as a duplicate of bug report #3450 as both reports is suggesting the same thing: to shorten the command.

image.png

image.png

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Hard-to-type command words

All command words are rather long and include dashes, which makes it time-consuming for the user to type, given that user will be typing these command words repeatedly and for every single time they use the command.

Commands like edit-policy and delete-policy could be shortened to editp and deletep instead, while still easy to remember.

[original: nus-cs2103-AY2425S1/pe-interim#2601] [original labels: severity.Medium type.FeatureFlaw]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Thank you for your inputs! After carefully considering your suggestion, the team would like to politely reject it due to the following reasons:

  1. Our app is designed for fast typist so such minor differences in command length should not be significant.
  2. We felt that using the command words as provided by you could be less intuitive. Commands such as "editp" is not immediately self-explanatory considering p could mean several things in Prudy (i.e. Phone number, preferences, policies), which may cause confusion.
  3. We would like to have Prudy commands as similar to the english language as possible, considering the application will be used by non-technical users. Having the command words resemble english words will allow for a more gradual learning curve for using the application.
  4. Having the command words to resemble the english language allow users to "type what they have on their mind". For example, if the user thinks of "editing policies", the user can simply type what is on their mind (i.e. edit-policy), making it easier to remember these commands, compared to consistently associating "editing policies" with "editp".

Furthermore, the team would like to highlight that the bug reported could be classified as a suggestion.

Regardless, we really appreciate the thoroughness of the bug report.

image.png

image.png

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

## :question: Issue response Team chose [`response.NotInScope`] - [x] I disagree **Reason for disagreement:** I feel that having commands that are difficult to type is fundamental `FeatureFlaw` of the application primarily because the application should be designed with efficiency, speed, and typing in mind. - - - > 1. Our app is designed for fast typist so such minor differences in command length should not be significant. I disagree with this because the length the commands are much longer than usual CLI commands (E.g. most Furthermore, the inclusion of hyphens (`-`) drastically reduces the speed at which a user can input commands, even if they are a fast typist. This is because it the position of the hyphen (`-`) on a standard QWERTY keyboard requires the user to take their fingers off the home row. - - - > 2. We felt that using the command words as provided by you could be less intuitive. Commands such as "editp" is not immediately self-explanatory considering p could mean several things in Prudy (i.e. Phone number, preferences, policies), which may cause confusion. I disagree with this because I don't think that 'intuitiveness' should be the primary focus of a CLI application. I agree that learning a command such as `editp` is requires a steeper learning curve than a more self-explanatory command, such as `edit-policy`, but I am of the opinion that this steeper learning curve is worth it for the long-term efficiency gains, especially for a CLI application. Most CLI tools have cryptic commands (E.g. `chmod`, `chown`, `cd`) but the benefits of having a short and easy-to-type command seem to far outweigh the con of having a steep learning curve for beginners. - - - > 3. We would like to have Prudy commands as similar to the english language as possible, considering the application will be used by non-technical users. Having the command words resemble english words will allow for a more gradual learning curve for using the application. Similar to the response to point 2, I disagree with this because I feel that speed and efficiency should be prioritised in a CLI application, even if it comes at the cost of having a slightly steeper learning curve. - - - > 4. Having the command words to resemble the english language allow users to "type what they have on their mind". For example, if the user thinks of "editing policies", the user can simply type what is on their mind (i.e. edit-policy), making it easier to remember these commands, compared to consistently associating "editing policies" with "editp". Similar to the response to points 2 and 3, I disagree with this because I feel that speed and efficiency should be prioritised in a CLI application, even if it comes at the cost of having a slightly steeper learning curve - remembering commands, in this case.
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** > `severity.Medium` : A flaw that causes occasional inconvenience to some users, but they can continue to use the product. It is clear that the functionality of the product is not affected by having difficult-to-type commands. However, in my opinion, the longer-than-average commands, coupled with the presence of hyphens (`-`), would cause 'occasional inconvenience', especially when users want to input many commands in succession. The extra keystrokes and time spent typing would add up to create a less enjoyable user experience. - - - > `severity.Low` : A flaw that is unlikely to affect normal operations of the product. Appears only in very rare situations and causes a minor inconvenience only. Furthermore, I do not think that this issue is a 'minor inconvenience' because I feel that efficiency is expected of a CLI application. I also feel that this issue occurs fairly regularly because most commands contain hyphens (`-`) and are rather long, save for a few such as `clear` and `exit`.