nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Incorrect descriptions in use cases #260

Open nus-pe-bot opened 1 week ago

nus-pe-bot commented 1 week ago

Here is an extracted UC

Use Case: UC11 - Delete a Tag from a Student Main Success Scenario (MSS):

  1. Educator chooses to delete a tag from a student.
  2. System prompts for the student’s index and the tag name.
  3. Educator enters the student’s index and tag name.
  4. System validates the input.
  5. System removes the tag from the student.
  6. System displays a confirmation message. Use case ends. Extensions: 2a. The specified student index is invalid. 2a1. System informs the educator of the invalid index. 2a2. Educator enters a valid index. Use case resumes from step 3.

For extension 2a, use case should resume from step 4, since educator has already inputted a valid index, but Educator enters the student’s index is repeated in step 3.

Recommend:

Extensions: 2a. The specified student index is invalid. 2a1. System informs the educator of the invalid index. 2a2. Educator enters a valid index and tag name. Use case resumes from step 4.


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

wenjebs commented 6 days ago

Team's Response

The incorrect numbering impacts only a single use case, making its scope very limited. As a result, it affects only a small number of readers and is unlikely to be encountered frequently.

While the issue might cause minor confusion for readers trying to follow that specific use case, it does not hinder the core functionality of the product. Readers can still refer to other use cases or easily deduce the correct steps, meaning any inconvenience is brief and easily resolved.

For an issue to be classified as severity.Medium, it must cause "occasional inconvenience" to readers. Since this issue affects only a single use case and does not significantly impact the overall usability or the experience of most readers, it is more appropriate to categorize it as LOW severity.

Duplicate status (if any):

--