search

teojunda / pe

0 stars 0 forks source link

Commands are too long and not optimised for fast-typists #12

Open teojunda opened 4 months ago

teojunda commented 4 months ago

Screenshot 2024-04-19 at 5.08.52 PM.png

User has to type in full words like --phone=, --email=. This makes it difficult for user to type. Short hand commands will be more effective like --p=

nus-se-script commented 4 months ago

Team's Response

Short hand commands can be confusing to users as some fields have the same starting letter. For example, name and note both start with n.

The decision to use full word commands was also made in consideration of any extensions in the future (i.e. if we want to add new fields that have the same starting letter as an existing field).

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: > Short hand commands can be confusing to users as some fields have the same starting letter. For example, name and note both start with n.

Initially, short hand commands may take some time to learn. However, it is much faster than typing out entire words once the user is familiar with the commands. For example, fast typists are familiar with git commit -m "message after using it a few times. It would be much more annoying to them have to type git commit -message "message everytime.

The decision to use full word commands was also made in consideration of any extensions in the future (i.e. if we want to add new fields that have the same starting letter as an existing field).

It is not necessary to restrict shorthand to just the starting letter of the word as short hand. For example, if there are 2 fields with the same name, name and note, name may be shortened to na and note may be shortened to no.

When considering future extensions, using shorthand will be a lot more effective, especially if some field names are very long. For example, the application adds emergency contact or office number as a parameters, it will be much faster to type ec and on rather than the full words.

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** This is not a cosmetic issue. It hinders the experience of the app for fast-typists.