Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

UG information about parameters #6

Open
zzhikai opened this issue Apr 16, 2022 · 1 comment
Open

UG information about parameters #6

zzhikai opened this issue Apr 16, 2022 · 1 comment

Comments

@zzhikai
Copy link
Owner

zzhikai commented Apr 16, 2022

Nowhere in the UG was it clearly mentioned that phone number has the conditions as stated in the error message below. Though a small matter.
You can include a parameter summary table at the top of the features section to allow the readers to know the constraints of each parameter better instead of only finding out when using the product.(eg. PHONE_NUMBER : "message stated in error message below")
This will also aid long term users, where they can just check the summary table at a glance while using to ensure their commands are correct.
Screenshot 2022-04-16 at 3.30.19 PM.png

@soc-se-bot
Copy link

soc-se-bot commented Apr 19, 2022

Team's Response

Specifying all the constraints in the UserGuide would be very technical and might be overbearing to users. Too much technical information in the UserGuide might turn off users and confuse them instead. The constraints imposed is to protect users from erroneous input, and not meant to limit them. Hence, we feel that it is not necessary to include it in the UserGuide.

Items for the Tester to Verify

❓ Issue response

Team chose [response.Rejected]

  • I disagree

Reason for disagreement: [replace this with your explanation]


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants