nus-cs2103-AY1920S2 / pe-dev-response

0 stars 0 forks source link

Minimal glossary #753

Open nus-pe-bot opened 4 years ago

nus-pe-bot commented 4 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.


As there are many features in this program, such as schedule, calendar, slots etc. It would be good to expand on the Glossary in the DG to briefly cover these terms so a new reader can familiarise themselves with easier reference:

image.png


[original: nus-cs2103-AY1920S2/pe-interim#728]

shenghaoc commented 4 years ago

Team's Response

We believe that the terms we have chosen, such as those that you listed, do not have special meanings specific to the app that require definitions to be included.

They are commonly used by other scheduling/calendar applications and are the natural way to refer to these things in the English language.

In the textbook example, there is a need to explain the two different types of squares because the meanings are specific to a game (Snakes and Ladders) that some people might not have played or might have forgotten.

In the AB3 DG, there is a need to define "mainstream OS" because while in theory the JVM can be ported to any platform, you should expect far more limited availability of and support for Java on non-mainstream OSes.

The glossary should not be misconstrued as a dictionary that defines every term used, to add definitions unnecessarily would be an insult to the reader.

Duplicate status (if any):

--