nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

`RSVP` not explained until the section under Dietary Requirements in UG #3258

Open nus-se-script opened 1 year ago

nus-se-script commented 1 year ago

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.


At first, you have introduced the term RSVP in your introduction as shown in the image below.

image.png

I wasn't very sure what RSVP means and hope that I can obtain an explanation under the RSVP Status panel section which to no avail. Throughout the section, the term RSVP is heavily utilized, which I am still unsure what it actually does/means.

image.png

Only through the image below:

image.png

I am then able to infer that RSVP is a status that indicates whether a guest is arriving for the wedding, which I believe could have been explained earlier. Perhaps you could have explained under the RSVP Status panel section. Otherwise, users have to search up the internet for this acronym used to understand its meaning.


[original: nus-cs2103-AY2324S1/pe-interim#4601] [original labels: severity.Low type.DocumentationBug]

p-xp commented 1 year ago

Team's Response

We believe it is best not to define the term RSVP as:

Duplicate status (if any):

--