search

nus-cs2103-AY2223S2 / pe-dev-response

1 stars 0 forks source link

[User Guide and Developer Guide] Absence of a glossary/missing terminologies to clarify novel/hard to understand terms #1913

Open nus-pe-bot opened 1 year ago

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

Details

As stated. This results in users/developers having to search the internet for what the terms mean and these may not match with the intended definition.

Expected

Developers are expected to produce a glossary of terms that users may be unfamiliar with in the User Guide (e.g. Command Line Interface, Graphical User Interface, command terminal, etc.)

They are also expected to produce a glossary of terms that differ from what a developer is expected to know in the developer guide (the only term mentioned is Mainstream OS, but other terms such as CRUD, in-app reference, etc. should also be added

Screenshots / Screen recordings

Screenshot 2023-04-14 at 3.35.06 PM.png

Screenshot 2023-04-14 at 3.36.47 PM.png

[original: nus-cs2103-AY2223S2/pe-interim#1581] [original labels: type.FunctionalityBug severity.Medium]

ARPspoofing commented 1 year ago

Team's Response

It does not hinder the user's information given that there were no jargons used, therefore it should not be medium. The suggestion could be implemented in future iterations, which is why it is set to not in scope. Furthermore, there is no specific requirement to clarify novel or hard terms (which our UG does not have.) Therefore, we set it to Low and not in scope.

Duplicate status (if any):

--