search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Glossary: Unnecessary term included #3305

Open nus-se-script opened 5 months ago

nus-se-script commented 5 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.

DG Page 66: MSS shouldn't be included since everyone who knows how to write use cases will know what MSS is.

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

chiageng commented 5 months ago

Team's Response

MSS is in fact a technical term. As we want to cater to all levels of developers, we have included this. Excluding it from the DG may cause some developers to be confused, but including it will value add to the developers, hence we believe that it makes sense to include it as a valid glossary term.

Furthermore, MSS hold many different meanings and we want to ensure that no developers would get confused as to what MSS refers to.

image.png

Since including the term "MSS" in the glossary value adds to the DG, we believe that it is not unnecessary and should not be considered a bug.

Duplicate status (if any):

--