soc-se-bot
commented
4 months ago Team's Response
Not a valid bug at all. There is no right place to add this consolidated table.
Too early and users will not understand what it's about. Too late and users might have already input something wrong by the time they scroll to the bottom of the user guide.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: > Not a valid bug at all. There is no right place to add this consolidated table.
Too early and users will not understand what it's about. Too late and users might have already input something wrong by the time they scroll to the bottom of the user guide.
Readers would appreciate having a consolidated table of parameter constraints placed after the summary of commands. Many readers do not read the user guide in chronological order. Instead they jump from section to section based on what they are interested in. Therefore, it is not a big deal even if the information is provided early. Readers will eventually understand it.
By repeating the constraints of the same parameter in different sections, it makes the user guide unnecessarily long and forces the reader to read the same content over and over again. This confuses the reader as it makes it "hard to see what's similar and what's different" (see below) between the different sections. This hinders the readability of the user guide.
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** This is not a cosmetic issues as it hinders the reader from quickly digesting the information in the user guide. Repetitive content makes the user guide unnecessarily long and forces the reader to read the same content over and over again. This confuses the reader as it makes it "hard to see what's similar and what's different" (see below) between the different sections.
The constraints for phone number field is repeated in
addandeditcommands. It will be more helpful to have a consolidated table describing the constraints of all parameters. Otherwise, it is difficult for the reader as there is a lot of repetitive content to read through.