add command parameter specifications unclear in the User Guide (class number)

[kiatkat]

In the add command section of the User Guide, only restrictions on the name and phone number of the student are provided, as well as an incomplete restriction on the student number.

Based on testing, the true restriction for the class number is:

• Classes must be of the format T[xxx], where [xxx] is any alphanumeric string.

It is likely that without this information, users will misinput information, at least for the first time, and have to use the displayed error message to rectify their inputs instead. This is inconvenient and is likely to happen often.

[nus-pe-bot]

Team's Response

The Class Number section of the User Guide specified this.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

• [x] I disagree

Reason for disagreement: The section in the User Guide detailing this parameter definition is neither readily accessible from the add command, nor located near enough to be reasonable for the user to know where to reference it from - while I was testing, I personally did not notice that specification since I was referring to the details of the add command. Therefore, I believe that some users, which may not necessarily read the entire user guide before using the product, may become confused and inconvenienced when trying to add a student, but failing since this specification is not written in the add command specification. At the very least, I believe a hyperlink to the relevant section or a short, one-line summary of that section could be added to the add command. After deliberation, I will accept that this is not a severity.Medium bug, but should be a severity.Low bug. However, I maintain that this is still a potential inconvenience that could have been easily addressed.

---

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]

---