nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

User guide missing glossary #2797

Open nus-se-script opened 2 months ago

nus-se-script commented 2 months ago

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.


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.


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

Joseph31416 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

Duplicate status (if any):

--