tengcharmaine / pe

0 stars 0 forks source link

User guide missing glossary #22

Open tengcharmaine opened 2 months ago

tengcharmaine commented 2 months ago

Your user guide should contain a glossary since some user might not be tech savvy and hence might not understand words such as CLI. Better to have a glossary in ug also since there is a low possibility of users reading your dg.

nus-se-script commented 2 months ago

Team's Response

Thank you for pointing this out. However, we relabeled the severity as low. The reason is that while there isn't a glossary, words like CLI are clearly explained and links to tutorial videos are provided to help to user to understand them (see screenshot). As such, this is unlikely to affect the user's normal usage. Furthermore, it was never stated explicitly in the course that the glossary section is needed. As such, this is a good to have improvement that could be included in future iterations, but not necessary at this point, especially when key terms have been clearly defined in the user guide, and there's a glossary in the developer guide as well. Screenshot 2024-04-21 at 1.22.26 AM.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [replace this with your explanation]


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]