search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Excessive Terms in Glossary #2857

Open nus-se-script opened 2 months ago

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

I would think that the Glossary has too many terms that the user does not require to know the operate the app. Public knowledge like what Windows, MacOS and JSON are terms would be considered public information that is not specific to the application. I don't all these terms should be included because it would decrease the usability of the glossary.

image.png

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

larainezo commented 2 months ago

Team's Response

Thanks for the suggestion! However, we feel that for glossary, adding more details would only benefit more users who may be unclear with certain terms used (even though they could be "common sense" for many).

Duplicate status (if any):

--