minreiseah / pe

0 stars 0 forks source link

The `listtasks` documentation does not explain what the numbers on a task card represents #4

Open minreiseah opened 2 months ago

minreiseah commented 2 months ago

image.png

The listtasks documentation does not explain what the numbers on a task card represents. I do not know what the 2., 1. in the first card mean. I would expect an ordered list.

nus-pe-script commented 2 months ago

Team's Response

This issue is referring to the numbers before the employees name under "Employees Assigned:". Addressed in #1998.

The 'Original' Bug

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

The list of employees assigned in a task card is confusing

image.png

The list should showcase the employees in sorted order. While the numbers represent the employee id, it is not obvious to the user on their first use of the product, creating unnecessary friction for adoption.

Moreover, even if the numbers represent the employee id, they should at least be sorted in the proper ascending (downward) order.


[original: nus-cs2103-AY2324S2/pe-interim#2538] [original labels: severity.Low type.FeatureFlaw]

Their Response to the 'Original' Bug

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

The employee id is created for the sake of the app to differentiate employees. This was done in consideration that we allow employees with duplicate names as mentioned in the planned enhancements.

While we agree that we should have sorted the IDs in ascending order instead, it is not a priority issue as of now as it is more of a cosmetic issue.

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: The "duplicate issue" in question suggests the team to sort the tasks in ascending order. My issue, however, pertains to the confusion a user faces at what the numbers represent in the first place.


## :question: Issue response Team chose [`response.NotInScope`] - [x] I disagree **Reason for disagreement:** The team's response explains why the employee id was used as the numbering for the task list, however this does not address the *lack of communication to the user* in the product.
## :question: Issue type Team chose [`type.FeatureFlaw`] Originally [`type.DocumentationBug`] - [x] I disagree **Reason for disagreement:** My issue pertains to a documentation issue as the user guide does not mention nor explain what the numbers on the list of tasks represent. This does not pertain to a feature flaw.