search

w-yeehong / pe

0 stars 0 forks source link

Missing details in User Guide: sorting displayed event section #9

Open w-yeehong opened 3 years ago

w-yeehong commented 3 years ago

Expected Outcome

Section on Sorting displayed events should describe what happens if events have the same description.

Description

The user guide only describes that sorting is done in alphabetical order.

image.png

nus-se-bot commented 3 years ago

Team's Response

I agree that it may be a valid issue, but I believe the particular section on UG still explains the feature well. As I did not plan to go further to sort beyond the event descriptions, I did not think that it is necessary to include the description of what happens with the events with same descriptions. Hence, I categorized it as "NotInScope" .

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: Hello, thank you for your response. I respectfully disagree that this issue is not in scope.

I understand that for this particular command, you may not plan to sort attributes other than the event descriptions. However, I think in general features should be clearly documented for the user, especially for exceptional behaviors.

From the one line in your documentation, I would not know how exactly the sorting feature behaves when there are multiple events with the same descriptions. Does the application sort these events by date, date and time, or even randomly? Even if you do not plan to implement sorting by a secondary attribute, when the user sorts by descriptions, the other attributes do determine the order in which the events are sorted.

Because there is a direct link to the feature, the UG should let the user know what to expect, and thus this issue is in scope.

:question: Issue severity

Team chose [severity.Low] Originally [severity.Medium]

Reason for disagreement: I do not think you provided the justification for changing the severity level from Medium to Low.

The reason I marked this issue as Medium severity is because the missing details cause the UG to be unclear and inconvenient for the user. For example, your application does not have built-in support for recurring events. A user who wants to keep track of recurring events may want to add multiple events with the same descriptions, and they may want them sorted by descriptions, followed by date and time. Since the UG does not mention that or show any examples, the only way for the user to find out how events are sorted is to test the application herself. I think that at the very least, perhaps you may like to include some examples to demonstrate the behavior when adding events with the same descriptions to avoid creating additional work for the user.