Open Devanshshah1309 opened 1 year ago
We reject this bug because:
tag
is not used as a technical term here; the meaning of tag
used here is assumed to be common knowledge.
Our application is meant for NUS SoC teaching assistants. What an index
is should be common knowledge for our user group. There are also plenty of contextual clues in the UG which would lead one to conclude that an index
is a number that corresponds to an item.
For the same reason, what a variable
is should be common knowledge for our user group. Again, there is enough information in the user guide to infer what a variable
is.
The text implies that the arguments with (optional)
are the variables, as we need only a minimum of one.
Team chose [response.Rejected
]
Reason for disagreement: Thanks for the detailed response!
By the way, the examples in my issue are not meant to be exhaustive. These were just some suggestions which your glossary should have included.
Also, I don't think the choice to not include a glossary section in the UG was intentional anyway.
What's more interesting is the fact that you claim your target audience is the NUS SoC teaching assistants. Your UG and DG mention (clearly) otherwise:
In particular, note that this app is meant to be used by ALL Teaching Assistants, not just SoC**.
Another problem with your argument regarding such terms being "common knowledge" is the fact that your DG does, in fact, have a glossary section! So you are aware that it is possible for some of theses terms to be unfamiliar with readers. For example, you even explain obvious terms like TA in the DG glossary but not in the UG.
For non-SoC students, terms like "index" and "variable" are foreign and unfamiliar. Terms like CLI and GUI are probably intimidating for them too. Anyway, it is clear that there are a lot more technical jargon (e.g. "open source", "parameters") thrown around in the UG which have not been explained.
All this shows poor user-consideration by not including a glossary section for such users. As mentioned in the original comment,
Medium priority since the UG does little to help a user understand such important parts of an application. If I don't know what "index" means, how do I use the commands that use "index"?
It does cause minor inconvenience to some users and so, should be medium severity.
Team chose [severity.VeryLow
]
Originally [severity.Medium
]
Reason for disagreement: Another (intentional?) change of severity to veryLow
when the bug is (obviously) not cosmetic
I still think the severity of this issue is medium as described earlier (in the issue response part). In case (not sure how it will show up on GitHub) it is not navigable, I've copy-pasted my rationale here too:
Thanks for the detailed response!
By the way, the examples in my issue are not meant to be exhaustive. These were just some suggestions which your glossary should have included.
Also, I don't think the choice to not include a glossary section in the UG was intentional anyway.
What's more interesting is the fact that you claim your target audience is the NUS SoC teaching assistants. Your UG and DG mention (clearly) otherwise:
In particular, note that this app is meant to be used by ALL Teaching Assistants, not just SoC**.
Another problem with your argument regarding such terms being "common knowledge" is the fact that your DG does, in fact, have a glossary section! So you are aware that it is possible for some of theses terms to be unfamiliar with readers. For example, you even explain obvious terms like TA in the DG glossary but not in the UG.
For non-SoC students, terms like "index" and "variable" are foreign and unfamiliar. Terms like CLI and GUI are probably intimidating for them too. Anyway, it is clear that there are a lot more technical jargon (e.g. "open source", "parameters") thrown around in the UG which have not been explained.
All this shows poor user-consideration by not including a glossary section for such users. As mentioned in the original comment,
Medium priority since the UG does little to help a user understand such important parts of an application. If I don't know what "index" means, how do I use the commands that use "index"?
It does cause minor inconvenience to some users and so, should be medium severity.
There is no glossary (or equivalent) section in the UG.
Important terms like
tags
,index
,variable
etc. can be defined in the glossary.Currently, there is no way for a user to know what these terms mean. Medium priority since the UG does little to help a user understand such important parts of an application. If I don't know what "index" means, how do I use the commands that use "index"?