jerrrren / pe

0 stars 0 forks source link

Confusing attribute repeats in UG #5

Open jerrrren opened 1 year ago

jerrrren commented 1 year ago

Some of the arguments can be allowed to have multiple instances for instance steps(s/) but for attributes like (n/) this is not the case. This difference should be brought up in the UG considering there is no specific explanation on what multiple steps input actually mean.

nus-se-script commented 1 year ago

Team's Response

  1. descriptions on each recipe field have been provided in the recipe attributes table. hence, it should be safe to assume that if a user reads the documentation properly, they would know that the n/ prefix is used for the recipe name and the s/ prefix is used for recipe steps, and should be able to reason that a recipe should only be able to have one name.

image.png

image.png

  1. given that our app is targeted towards people who cook, it should be reasonable that our users would understand what a "step" is in the context of a recipe, and why we can have multiple of them.

  2. even if users are unable to deduce what a recipe step means, they can also look at the various examples provided all around the user guide, most notably at the command examples and screenshots provided in the add command section of the documentation. on top of that, users can also take reference to the sample data provided within the app.

image.png

given these examples, it should be intuitive to the user that a recipe step refers to one of the many instructions in a recipe, e.g. "cut up tomatoes", "boil potatoes for 10 minutes", "add soy sauce and stir well". hence, it should also be clear to them why multiple steps should be allowed in a recipe: no one cooks a recipe in one step!

bug report rejected.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]