yyccbb / pe

0 stars 0 forks source link

Command format for delete-an in the summary table of UG is different from that in its designated section #15

Open yyccbb opened 2 months ago

yyccbb commented 2 months ago

image.png The parameter INDEX is renamed NOTE_INDEX. Based on the definition in the corresponding section for delete-an, INDEX refers to the index number shown in the displayed patient list. The new name NOTE_INDEX apparently has nothing to do with the original definition and this causes confusion.

nus-se-bot commented 2 months ago

Team's Response

I've decided to assign Rejected this issue instead of assigning NotInScope as the tester did not understand how the system works.

INDEX / NOTE_INDEX refers to the appointment note / appointment record. While the I agree that the consistency can be improved, both portion of the documentation refers to the same thing and the documentation is factually correct.

Screenshot 2024-04-20 at 9.36.50 PM.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: * Note: I would like to change the severity level to low. First, I do not agree with the responder's view that users have to deduce how the system works first before they attempt to refer to the UG to run a command. Second, I simply do not think a new parameter appearing in the command format under the summary section is something as simple as a cosmetic issue, because it does lead to confusion. This is worsened by the incorrect definition of INDEX in the corresponding detailed section for the command. I do recognize that deductions based on the matching parameter positions might be able to help the user understand the command format better. Based on all these reasons, I think Severity.Low is more suitable.