soc-se-bot
commented
2 months ago Team's Response
We believe that the required fields for each person type is explicitly shown in the add command formats, as seen in the screenshot below. The add command creates each person type and thus, encompasses all the fields required for that type of person.
Unfortunately, as the UG is suppose to the be concise and easy to read, we cannot include every single detail and spell everything out explicitly. Thus, we purposefully left this additional explanation out to prevent the constraints list from being too convoluted as the fields required for each contact type is made clear in our command.
Below is from the course website stating that it is not necessary to spell out all details in ug:
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: The current format of the add command in the UG, while streamlined, may not sufficiently guide new and inexperienced users through the process of trying to add new users to the application. Users unfamiliar with the application might not infer that all fields listed in the command format are required, especially if they are accustomed to interfaces where optional fields are common. As seen from the screenshot below, it is not mentioned anywhere in the UG that the attributes below are required or not and as new users, I may assume that I would be able to leave out attributes such as phone number when I do not have their contact number. This would cause frustrations to me when I add such contacts to my application and instead of being able to do what I assumed was supported, the app does not allow me to do so and throws an error .
For clarity and usability, particularly for those with less experience, it would be beneficial for the UG to explicitly state which fields are mandatory for each person type. Doing so would reduce the learning curve and user error, facilitating a smoother introduction to the application. While conciseness in a UG is valuable, the omission of such lack of guidance could lead to confusion and a suboptimal user experience. Ensuring users are confidently informed about required fields from the outset can prevent frustration and support efficient use of the application.
In the UG, the needed values for each different person type is not explicitly stated to be required and only states which is valid for what person type.