User Guide has too few examples

[nus-se-script]

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

---

The user guide has too few examples to cover the potential command inputs.

In the uploaded example, the addmember feature only shows one example even though there can be many possibilities such as excluding all the optional parameters etc.

I believe that this makes the user guide less clear which can be improved.

---

_{[original: nus-cs2103-AY2324S1/pe-interim#2279] [original labels: type.DocumentationBug severity.VeryLow]}

[Saezenn]

Team's Response

Thank you for the report. There seems to be a misunderstanding on how many optional parameters there are. For the addmember command, there is only one optional parameter, which is /tag. If we were to give another example, it would be an unnecessary repetition, as it would be very difficult to see what's different. For example, the 2 examples we could give, following your suggestion, would be :

1) addm /name Taylor Swift /phone 91691969 /email taylorswift@era.tour /tele @tswift /tag Admin This adds a new member named Taylor Swift with phone number 91691969, email taylorswift@era.tour, telegram handle @tswift and tag Admin to the list of members. 2) addm /name Lady Gaga /phone 91239123 /email pokerface@gmail.com /tele @badromance This adds a new member named Lady Gaga with phone number 91239123, email pokerface@gmail.com, telegram handle @badromance to the list of members.

These 2 examples are very similar with only 1 parameter being different. In terms of the difference in GUI, the member added would only be missing a "Admin" icon on their member card.

Furthermore, there are examples within the UG that use the addm command without the optional parameter, as shown here:

This would only be relevant if our product had more optional fields in the addmember command. However, as of the current iteration, there is only 1 optional parameter, and hence another example would be unnecessary.

Duplicate status (if any):

--