search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Edit Illness Information Slows Readers Down #3541

Open nus-se-script opened 5 months ago

nus-se-script commented 5 months 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.

Description & Reason for Severity

There's a section in the UG that details how to edit various types of information. However, the information for editing illness is quite hard to read, potentially slowing down readers as they have to identify the three separate points by themselves - valid illness, removing all illness, and shorter forms, which are combined to one long paragraph instead of separating the points or somehow indicating to the readers that there are 3 points. As this slows readers down, its of low severity and not higher!

image.png

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

jmsandiegoo commented 5 months ago

Team's Response

We decided that making the explanation more concise can be pushed on future releases and could be considered as an enhancement. Currently, the documentation's aim is to elaborate on the important characteristics of each constraint so as to avoid confusion amongst users due to it being vague and it being too short. Though, we would definitely improve the organization perhaps and conciseness in future releases. NotInScope.

Duplicate status (if any):

--