search

lil1n / pe

0 stars 0 forks source link

Order of functions could maybe be reordered in UG #16

Open lil1n opened 1 year ago

lil1n commented 1 year ago

Since a category needs to be added first before being able to add an event, it would be better to have Add a Category: category appear before Add an Event: event since user is not allowed to add a category after providing an event command

or perhaps could add warnings or tips under add an event: event to inform user that they should use view first or add a category first before using the event command (so it is easier to use for user as they will know what to expect / how MoneyMind behaves)

nus-pe-bot commented 1 year ago

Team's Response

Duplicate report, but thanks for pointing out

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: This issue is on the order of functions, particularly, adding a category should come before adding an event (since there needs to be category before addition of events, hence it would be more logical to order addition of category first to aid new users), while the other issue is on a specific bullet point in the section of adding an event (saying that it could be explained better to understand how the budget calculation works).