WilsonLee2000 / pe

0 stars 0 forks source link

The User Guide is not well-explained for `event`, causing tester misunderstanding due to inadequate information. #16

Open WilsonLee2000 opened 1 year ago

WilsonLee2000 commented 1 year ago

Hi Team, I was in a deep state of lost and confusion at the first part when trying out the event function. This is because the event function needs at least one category for the event to be added inside the category. Moreover, I was also not informed that I need to create a category first or whether the categories are already provided by MoneyMind initially.

image.png

nus-pe-bot commented 1 year ago

Team's Response

Duplicate issue, thanks for pointing out though

The 'Original' Bug

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

UG add an event quite confusing?

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.


I think that the last bullet point in Add an Event: event could be better phrased and explained. maybe solving this issue could resolve the issue mentioned earlier regarding the issue on view not indicating that budget has exceeded for a category (the inconsistent behaviour where it says exceed for one but not exceed for another when the event in both categories were greater than the budget set)


[original: nus-cs2113-AY2223S2/pe-interim#2896] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

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

Yes agree that it is indeed a flaw in the documentation that we did not specify this clearly and also the sequence of the features being elaborated in the UG might result in this confusion too, however, I do feel that the severity of this problem should be low because we did specify at the start of the section in UG that an event must be included in a category. And in this case, when the users find out that there is no category presets, they should know to create one. Thanks for pointing this issue out anyways!

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 severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** This is of severity.Medium because the User Guide is not well-explained for `event`, causing tester misunderstanding the `event` feature due to inadequate information. It causes occasional inconvenience to users especially when users are confused about how does the `event` function work in MoneyMind and if users misunderstood/misinterpret on how to properly use the `event` function, it can cause other features in MoneyMind to be not of use to readers when they are unable to use the most basic `event` function of MoneyMind.