nus-pe-bot
commented
2 years ago Team's Response
The definition is required as it is mentioned in our Developer Guide and some readers might not have knowledge of it.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: Justifying the inclusion of this principle in the glossary with "some readers might not have knowledge of it." opens up a rabbit hole of all sorts of terms in the DG you can define that "readers might not have knowledge of". This is not a strong justification for including a term in the glossary. For example, if we go by the developer team's argument, then the team should also have included a definition for "Use Case", "Non-Functional Requirement", "Logging" etc. and many other terms that "readers might not have knowledge of", making the glossary a dictionary.
As implied by the example in the module textbook, the glossary should include terms used by the developer team that is specific to their project and may be misinterpreted or difficult to understand for readers:
But the definition of Graphical User Interface is widely known by computing professionals and in the software engineering industry. Given that the likely readers of the DG are software developers or computing students, they will most likely know about a GUI already.
Unnecessary terms included in the glossary is considered a bug:
:question: Issue severity
Team chose [severity.VeryLow]
Originally [severity.Low]
- [x] I disagree
Reason for disagreement: As mentioned in the guidelines, only cosmetic problems should have a very low severity. This bug is not a cosmetic problem.
The definition of GUI should not be included in the glossary as this is a widely-understood term that is not specific to your project.