search

nseah21 / pe

0 stars 0 forks source link

Glossary missing for some technical terms #13

Open nseah21 opened 2 years ago

nseah21 commented 2 years ago

Some technical jargon like CLI and GUI is not explained in the UG, which can trip up and hinder the reader, especially if it is on the first page of the UG.

Since the target users are department store employees/managers, it is difficult to expect them to know what CLI/GUI means.

image.png

soc-se-bot commented 1 year ago

Team's Response

We feel there is no room for different interpretations of the terms CLI and GUI, which is why we did not define them in the glossary. i.e. CLI and GUI are straightforward terms that have a single meaning that is not specific to the context of our app. Hence, the reader is expected to Google the terms himself if he is not sure what they mean.

Therefore we reject this issue.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The issue here is that CLI and GUI are technical terms that a non-technical user (i.e. department store management employee) is likely to be unaware of.

We feel there is no room for different interpretations of the terms CLI and GUI, which is why we did not define them in the glossary. i.e. CLI and GUI are straightforward terms that have a single meaning that is not specific to the context of our app. Hence, the reader is expected to Google the terms himself if he is not sure what they mean. Therefore we reject this issue.

While CLI and GUI are straightforward terms, the user should not be expected to have to search for the terms online on their own. The user guide should provide enough information for the user to understand the app without having to toggle between multiple links or documents.

Furthermore, the team seems to have failed to consider users who are referring to a hardcopy version of their UG. For these users, they would be hindered by the lack of a glossary in the UG, and end up wasting additional time logging on to their mobile/desktop devices to perform the Google search.

:question: Issue severity

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

Reason for disagreement: As mentioned above, this is not a cosmetic issue, as the users would need to perform the Google search on their own accord. This will cause them to spend time and effort looking for an explanation which should have been provided in the user guide.

This is especially the case for users referring to a manual copy of the user guide, where the hyperlinks cannot be used directly.