search

shaunlxw / pe

0 stars 0 forks source link

add required words in glossary: CLI, GUI #15

Open shaunlxw opened 4 months ago

shaunlxw commented 4 months ago

Since these are technical terms (less technical terms have been included in the GUI), they should be included in the glossary.

image.png

image.png

nus-pe-script commented 4 months ago

Team's Response

CLI and GUI terms are widely understood by Computing students, especially Computer Science tutors. We deliberately chose not to include these terms in the UG as it will add little to no value to tutors. Furthermore, these terms have already been included in the Glossary section of the DG.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: If these terms are omitted, then the commonly understood terms (such as participation, attendance, and integers) should not need to be in the glossary too. And if those terms were included, CLI and GUI are more technical terms and are more meaningful to be explained the glossary. Furthermore, inclusion of these terms in the DG shows a need to explain these terms, and inclusion in the DG is not a reason for omission of explanation in the UG, since there is no guarantee that users that read the UG will read the DG.

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** Omission of explanation of certain relevant terms is not just purely cosmetic.