search

nus-cs2103-AY2122S1 / pe-dev-response

0 stars 0 forks source link

No elaboration in UG for purpose of `Description` field in tasks #5598

Open nus-se-bot opened 2 years ago

nus-se-bot commented 2 years ago

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.

UG does not mention what the description field for tasks is for. A Task Title field already exists, so a description fields might feel redundant to readers/users. An explanation of the purpose for it, and what differentiates title and description for tasks might have been useful.

image.png The image above shows the missing elaboration for title and description fields for tasks. No elaboration was found in other parts of the UG as well.

[original: nus-cs2103-AY2122S1/pe-interim#5621] [original labels: severity.Low type.DocumentationBug]

jeffsieu commented 2 years ago

Team's Response

We think it's extremely self-explanatory what a Title, and a Description is. An User guide should not be used as a dictionary for these very simple to understand terms.

Duplicate status (if any):

--