Tsenrae / pe

0 stars 0 forks source link

Missing Glossary in the User Guide #13

Open Tsenrae opened 5 months ago

Tsenrae commented 5 months ago

There is no glossary in the UG at all. Inexperienced users may not be able to understand terms like GUI.

soc-pe-bot commented 5 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Lack of Glossary

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.


image.png

The user guide seems to lack a glossary for some important key terms. As such, users may not be tech-savvy and know for example what is "Command Line Interface", "Command Terminal", "GUI", "Case sensitivity". It will definitely help users to understand the user guide better with these terms stated clearly and explained.


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

Their Response to the 'Original' Bug

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

No details provided by team.

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 severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** This bug should definitely not be of severity.VeryLow as this is not just a cosmetic issue. There are various technical terms that are not explained (`Command Line Interface`, `Command Terminal`, `GUI`), and this would hinder the user as they would have to google the terms to figure out what they mean. This knowledge may be required to actually understand the next steps in the User Guide. For example, if the user does not know what the `Command Terminal` means, he/she would not be able to understand this next step shown in your UG (see screenshot below) and hence not be able to follow it without googling the term. Hence, I believe this goes beyond a cosmetic issue, and actually inconveniences the user in rare instances. ![Screenshot 2024-04-24 at 6.18.41 PM.png](https://raw.githubusercontent.com/Tsenrae/pe/main/files/53f9b365-f079-42c6-9ad2-3b027da0fc2f.png)