search

kwuunnn / pe

0 stars 0 forks source link

Insufficient terms in Glossary #19

Open kwuunnn opened 5 months ago

kwuunnn commented 5 months ago

image.png

Glossary only includes TA, should include other terms like MSS etc

nus-pe-script commented 4 months ago

Team's Response

Glossary are reserved for (technical) terms that require clarification so all users will be on the same page. AronaPro does not use a lot of technical terms and as such the glossary is as it is currently.

The 'Original' Bug

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

Insufficient information about Glossary in DG

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.

Actual: One point given for the Glossary section Expected: Can provide more points in the Glossary section so that user will have a better understanding of what it is being delivered, thus, more information should be given.

image.png

[original: nus-cs2103-AY2324S2/pe-interim#3314] [original labels: type.DocumentationBug severity.VeryLow]

Their Response to the 'Original' Bug

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

Glossary are reserved for (technical) terms that require clarification so all users will be on the same page. AronaPro does not use a lot of technical terms and as such the glossary is as it is currently.

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`] - [x] I disagree **Reason for disagreement:** # From the CS2103T Website: ![image.png](https://raw.githubusercontent.com/kwuunnn/pe/main/files/ae88afeb-fa33-4d2f-a3b7-2123a3412df1.png) ## Acronyms like `OS`, `MSS` are technical terms that might not be understood by everyone. ![image.png](https://raw.githubusercontent.com/kwuunnn/pe/main/files/7d1b588c-6e63-4c33-9940-15f1e909811f.png) ![image.png](https://raw.githubusercontent.com/kwuunnn/pe/main/files/1546d069-f5d8-4670-9f7d-8816a0580a1d.png) ## Terms like `NUSID` is unclear because there is eXXXXXXX and AXXXXXXXX, so as a reader I would be confused what `NUSID` refers to. ## Abbreviations like `Prof` might not be obvious to some: ![image.png](https://raw.githubusercontent.com/kwuunnn/pe/main/files/ad1167c5-7b77-4a6f-93d4-e504750e462f.png)
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** # From the CS2103T Website: ![image.png](https://raw.githubusercontent.com/kwuunnn/pe/main/files/6364e05b-b707-4713-b939-a0df647cb7c4.png) Clearly, this is not a cosmetic issue, so it definitely should not be `VeryLow` The lack of terms in the glossary definitely causes a minor inconvenience to users that do not understand the terms used.