No glossary in DG for terms such as CLI and GUI

[CraveToCode]

Lack of glossary in general for DG. Alot of useful terms missing

[nus-pe-bot]

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

No glossary for GUI in UG

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.

---

GUI and CLI term might not be clear for readers who are not tech-savvy.

---

_{[original: nus-cs2103-AY2122S1/pe-interim#5617] [original labels: severity.Low type.DocumentationBug]}

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

From the textbook, a glossary serves to ensure that all stakeholders have a common understanding of the noteworthy terms, abbreviations, acronyms etc.

We have decided that GUI and CLI are not noteworthy abbreviations that we ourselves have to explain, since the abbreviation and understanding of these terms are widespread globally; there is already a common understanding of this abbreviation. A quick Google search would do for those who do not understand the term.

Thus, we left these two terms out with the intention to not clutter our Glossary and end up distracting focus away from terms that actually require explanation.

Items for the Tester to Verify

❓ Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

• I disagree

Reason for disagreement: The bug I have reported is for the DG. The claimed 'duplicate' bug is about the UG. Bugs for different documentations cannot be classified as duplicates of each other.
For example, assuming both documentations do not have diagrams, you cannot simply claim that they are duplicate bugs.

---

❓ Issue response

Team chose [response.Rejected]

• I disagree

Reason for disagreement: A developer is clearly a stakeholder of TaskMaster2103's DG. It is not an acceptable reasoning to assume ALL developers will know what CLI and GUI means, especially new developers.
The purpose of the glossary in any case is to contextualize the meaning of the term CLI and GUI with respect to the app. A google search does not provide such contextualized information,
but instead provides GENERAL information about CLI/GUI.

Furthermore, it is better to err on the side of caution. In your DG, there is no full form of CLI/GUI either, and the abbreviations are used from the get-go. This further necessitates the need for a glossary.

---