vibes-863 / pe

0 stars 0 forks source link

Too long description of Add in UG #11

Open vibes-863 opened 2 months ago

vibes-863 commented 2 months ago

image.png

The Instructions on adding a student is too long and very hard to read. The reader is thrown with a lot of information which confuses the reader.

nus-pe-bot commented 2 months ago

Team's Response

The descriptiveness of the Add student command is this long due to the importance of this command. Without the Add student command, the list can not be updated.

Moreover, as per tested in the program, the Add student command has quite a number of input parameters, and adding descriptions to each parameter would actually increase the ability for the user to understand the right format and justification for the command and parameters.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The point of the section 'Usage' is to convey to the users on how to use the different features, there is no need for "justification for the command and parameters". An example of such would be "Some may debate that our time zone is actually GMT+7.5 or GMT+7, but it was changed to facilitate business deals and decisions with other financial hubs in the region thanks to our capitalistic overlords".

I would argue that this greatly reduces the readability as it is an information overload for the user, which is not required in order to use a simple add function. It is increasing the complexity for no reason, which leads to the reader being tired of reading.


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** The team has not given a reason for why the severity is VeryLow and not Low Furthermore, the severity is not VeryLow as this is not a cosmetic bug. ![image.png](https://raw.githubusercontent.com/vibes-863/pe/main/files/fae0bf02-a2ed-40a3-9e2f-30cf83738d90.png) The above information has been screenshotted from the website.