FestiveCat / pe

0 stars 0 forks source link

Incredibly verbose notes for commands like add-b #19

Open FestiveCat opened 2 years ago

FestiveCat commented 2 years ago

image.png

Similarly for other features' notes.

A better way is to have a separate table/section on prefix usage/restrictions, ie Phone number must be all digits, at least 3 digits etc, Instead of having every command that uses these prefixes display every single restriction on them.

Makes it hard to read the UG and hence use the application.

nus-pe-bot commented 2 years ago

Team's Response

We aim to be thorough in our features section, so that when our user wants to use that command, they know the Dos and Don'ts

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Thoroughness is good, but not at the expense of readability.

An workaround is to introduce line breaks between points so that the reader is not overloaded with too many eye-catching markups (code, bold)