nus-cs2113-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Lack of `edit` feature in User Guide #1126

Open nus-se-bot opened 2 years ago

nus-se-bot commented 2 years ago

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]

adricpjw commented 2 years ago

Team's Response

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

Duplicate status (if any):

--