search

nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

No Glossary in UG #1934

Open nus-se-script opened 11 months ago

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

Screenshot 2023-11-17 at 5.24.59 PM.png

Medical staff might not know the meanings of Command Line Interface or Graphical User Interface

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

kohkaijie commented 11 months ago

Team's Response

Prof Damith mentioned that the use of a glossary in the UG or DG should only be used if the terms defined add value to the project i.e it may be unclear in the context of our application. Allow us to provide an example: in a game setting, a glossary can be used to define terms such as boxes and squares which in the game scenario, may differ from the conventional definition of a box and square as they may have special properties in the given context. Having a glossary to define terms such as Command Line Interface or Graphical User Interface do not add any value in the context of our app since they are terms that can be found online and do not have any extra meaning in the context of MediLink Contacts. Hence, there is no need to have a glossary for such a purpose.

Duplicate status (if any):

--