search

nus-cs2103-AY2122S1 / pe-dev-response

0 stars 0 forks source link

UG glossary is not a glossary #2241

Open nus-pe-bot opened 2 years ago

nus-pe-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.

Glossary is for definitions, not for command or field formats. Potential confusion and inconvenience for the user.

image.png

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

yeo-yiheng commented 2 years ago

Team's Response

We get the confusion regarding how a glossary should contain definitions but ours seemingly contain command formats. However, we intend for our users to view this information as definitions of our terminologies.

For example, it should be interpreted as:

We may not follow the usual way words are defined as we want to ensure that our definitions are clear enough for the user, thus we have included the formats for reference.

Duplicate status (if any):

--