search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Lack of glossary or definitions of technical terms #3359

Open nus-pe-bot opened 6 months ago

nus-pe-bot commented 6 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.

User Guide does not have a glossary to cover key terminologies that the target audience may not be familiar with. E.g. technical terms like "JSON", "Command Line Interface", "Graphical User Interface", "prefix" and "parameters".

It is reasonable that primary school tutors may not understand what these terms mean. This could cause difficulty for potential users in understanding the user guide.

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

tanqinyong commented 6 months ago

Team's Response

No details provided by team.

Duplicate status (if any):

--