paing-oo / pe

0 stars 0 forks source link

UG: Missing Glossary #9

Open paing-oo opened 2 years ago

paing-oo commented 2 years ago

UG does not have a glossary which will be difficult for non tech savvy recruiters to understand some of the terms specified in the UG.

Some terms that might be hard to understand includes: 1)Command Line Interface (CLI) 2)GUI 3)commands

nus-se-bot commented 2 years ago

Team's Response

We think this is a not a bug for 2 reasons:

image_2022-04-17_20-54-11.png

The 'Original' Bug

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

Absence of Glossary 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.


Absence of a Glossary in UG to help users read the guide


[original: nus-cs2103-AY2122S2/pe-interim#2451] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

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

We think this is a not a bug for 2 reasons:

  • In the module website, there was no requirement to set up a glossary for the user guide, and even the original Addressbook did not have a glossary in the UG.

image_2022-04-17_20-54-11.png

  • In our case, the glossary is also not required since there is no term that is specific to our app.

Items for the Tester to Verify

:question: Issue duplicate status

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

Reason for disagreement: [replace this with your explanation]


:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: image.png

In the section of possible UG bugs, "The information is hard to understand for the target audience. e.g., using terms the reader might not know", some terms such as CLI and GUI in the user guide are hard to understand for the target audience, recruiters in a company who might not have knowledge of such technical terms. Therefore, a glossary would help to explain these terms to the target audience.


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]