search

HugeNoob / pe

0 stars 0 forks source link

[UG] RSVP definition #6

Open HugeNoob opened 11 months ago

HugeNoob commented 11 months ago

Description

The group makes use of the term "RSVP" in their product and UG, but does not define this term anywhere.

I don't believe that the meaning of RSVP is obvious to everyone. In fact, I don't even know what RSVP stands for.

Elaboration of labels

Low because it is not just a comestic issue, but a lack of documentation and definition.

soc-se-bot commented 11 months ago

Team's Response

Duplicate as both are about the term RSVP not being defined.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

RSVP not explained until the section under Dietary Requirements in UG

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]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

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

  • It is common knowledge for our target audience of wedding planners. This is because the term RSVP very commonly used in event and wedding planning.
  • For the above reason, defining it can be harmful as it might make our user guide seem patronizing and not tailored to our target audience.

    Items for the Tester to Verify

    :question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

## :question: Issue response Team chose [`response.Rejected`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]