nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Incorrect information in User Guide #1832

Open nus-se-script opened 1 week ago

nus-se-script commented 1 week ago

In the User Guide, under the addingparent session there seem to be a mistake. image.png

  1. User will be very confused where John Ho came from when the command uses the John Doe as the name.
  2. It says that the command adds a student. Shouldn't the addparent command be adding a parent instead of a student?

[original: nus-cs2103-AY2425S1/pe-interim#2516] [original labels: severity.Medium type.DocumentationBug]

elliot-tang commented 1 week ago

Team's Response

Thank you for highlighting the discrepancy in the example provided for the addparent command in the User Guide. We understand your concern regarding the mismatch between the name used in the command (John Doe) and the name mentioned in the explanation (James Ho), as well as the reference to adding a student instead of a parent.

We have classified this bug as severity.Low with reasons stated below:

  1. While the mismatch may cause minor confusion, the command's format and usage are clearly explained in the User Guide, and users can refer to those details to execute the command correctly.
  2. The impact of this issue is minimal, as it only affects the understanding of a single example in the User Guide and does not disrupt normal operations or usability.

We will update the User Guide in a future revision to ensure consistency between the names and descriptions in the example. This will help prevent any confusion for users referencing the guide.

Thank you for bringing this to our attention, for helping us improve the quality of our documentation and for supporting GOATS.

Regards, Development Team

Duplicate status (if any):

--