search

nus-cs2113-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Technical jargons in UG #1332

Open nus-se-bot opened 2 years ago

nus-se-bot commented 2 years 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.

While this portion is important, the phrasing is way too technical for normies to understand. May want to omit the part for explaining the overflow.
image.png

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

pragyan01 commented 2 years ago

Team's Response

Thanks for sharing your thoughts on this! We feel that there will be users like you who'd feel overwhelmed by all the information but there will also be users who'd possibly complain about the lack of details about all our commands if we were to remove such information. As such, its best to have the information there to make it explicitly clear than to not have it at all. Moreover, a detailed UG will help you avoid errors in your commands and accomodate easier troubleshooting as you'll know what went wrong and what commands are acceptable along with their parameters.

As such, we're rejecting this. Thanks for sharing though!

Duplicate status (if any):

--