search

leecheokfeng / pe

0 stars 0 forks source link

Missing section for 'edit' command #8

Open leecheokfeng opened 2 years ago

leecheokfeng commented 2 years ago

image.png

image.png

The software has an 'edit' feature which allows users to edit tasks in their timetable. However, explanations on how to use this command is not covered by the UG. It is only shown in the command summary section, but with no explanation.

nus-pe-bot commented 2 years ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Lack of edit feature in User Guide

Expected: Since edit is given as possible feature, it should be documented on how to use it.

Actual: There is no section on edit in the User Guide.

Rationale: In most applications, CRUD functionality forms the core of the app. Excluding edit from the UG might confuse readers who would think that there is no edit/update (U) feature. In addition, edit is only applicable for personal tasks, this should be made clear in a section of its own, since it personal tasks are only a small portion of your timetabling app.

User Guide's table of contents:

image.png

[original: nus-cs2113-AY2122S1/pe-interim#1096] [original labels: severity.High type.DocumentationBug]

Their Response to the 'Original' Bug

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

Downgrade of severity:
The edit feature is available in the command summary and when using help in the app.

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 reason]

:question: Issue severity

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

Reason for disagreement: [replace this with your reason]