search

vaidyanaath / pe

0 stars 0 forks source link

Lack of distinction between core and side features in command summary #14

Open vaidyanaath opened 1 year ago

vaidyanaath commented 1 year ago

image.png

Since there are 2 very different sets of features, it is confusing to view all of the commands in alphabetical order. It would be better to distinguish between the main and side features here as well

nus-pe-script commented 1 year ago

Team's Response

We decided to put our command summary in alphabetical order because all of our commands are executable in any available panel. The alphabetical order allows users to find the commands needed easily by quickly looking at the first letter of each command, which provides added convenience to the reader and not confusion. While you may argue that the two sets of features are very different, the side features serve to complement the main features. Displaying them together in the summary provides the reader the ability to use our software to its full potential. Furthermore, all of the commands provided are in correct format and it is only a summary provided for the detail instructions of commands given above, it should not earn a low-level severity. Thanks for your suggestion, but we decided to reject it here.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I understand your view and I agree that this can be better classified as a Very Low severity issue since it is related to layout. However, my main point still stands: It is very hard to differentiate between the 2 groups of commands.

Example 1: edit_contact, edit_content, edit_status are all placed very close to each other in the summary table. How would a user be able to identify whether each command is associated with a "Task" or an "Internship Application"?

Unless the user has read through the entire User Guide Document, he/she might end up trying to edit the status of a Task or edit the content of an Internship Application which are both invalid operations.

The alphabetical order allows users to find the commands needed easily by quickly looking at the first letter of each command, which provides added convenience to the reader and not confusion.

Example 2: The user would be confused about the difference between edit and edit_content despite being sorted in alphabetical order. Since they sound very similar and seem to perform the same function, as a user, I would greatly benefit from structuring it in a more user-friendly way.

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]