nus-cs2113-AY2122S1 / pe-dev-response

0 stars 0 forks source link

The user guide is unclear on the modules #1210

Open nus-se-bot opened 2 years ago

nus-se-bot commented 2 years ago

The list of available modules do not explain much about the modules themselves, and do not tell the user explicitly exactly what is going on and what the data encoder or decoder is doing. People who are unfamiliar with data encryption will find it difficult to understand the program and what it is doing as not much explanation throughout the user guide is given on what the encryption is actually doing.

image.png


[original: nus-cs2113-AY2122S1/pe-interim#1176] [original labels: severity.Medium type.DocumentationBug]

rizemon commented 2 years ago

Team's Response

In the introduction of the user guide,

image.png

there was already a statement mentioning our expectations of the target audience, which is that they already have "technical understanding of encoding schemes and cryptography". Any further explanation will reduce readability and therefore, is deemed not necessary.

Duplicate status (if any):

--