Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lack of a Glossary Section #10

Open
ngkaiwen123 opened this issue Apr 14, 2023 · 1 comment
Open

Lack of a Glossary Section #10

ngkaiwen123 opened this issue Apr 14, 2023 · 1 comment

Comments

@ngkaiwen123
Copy link
Owner

ngkaiwen123 commented Apr 14, 2023

It seems that there is no glossary section included in the DG. While it is safe to assume that most terms in the DG are commonly used, it helps to have a glossary to aid the reader.

@nus-pe-bot
Copy link

nus-pe-bot commented Apr 18, 2023

Team's Response

Not required in tP.

Items for the Tester to Verify

❓ Issue response

Team chose [response.NotInScope]

  • I disagree

Reason for disagreement: I refer to the screenshot cut out from the CS2113 Website as shown below.

Screenshot (518).png

As evident by this screenshot, not only important terms are missing, but the fact that the entire Glossary section is missing, should suffice as a potential Documentation Bug.


❓ Issue severity

Team chose [severity.VeryLow]
Originally [severity.Low]

  • I disagree

Reason for disagreement: severity.VeryLow should only be assigned to bugs that are purely cosmetic. Howver, missing an entire Glossary section of the Developer Guide cannot be justified as a purely "cosmetic" error. It may cause inconvenience to those who are less inclined to the English Language or terms used in the DG.


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants