zxisatree / pe

0 stars 0 forks source link

Delete command in DG Appendix: Instructions for Manual Testing has wrong explanation #23

Open zxisatree opened 1 year ago

zxisatree commented 1 year ago

The DG states that delete 1 will delete the first contact from the list, but the application appears to be using employee IDs, not list indexes for delete.

image.png

nus-pe-bot commented 1 year ago

Team's Response

Thanks for pointing that out, but we feel the severity could be Low as it is a typo under the 'manual testing' section unlikely to cause any major inconvenience. In fact, the correct explanation is included in the explanation for the 'delete' command

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.Low] Originally [severity.Medium]

Reason for disagreement: The section that the wrong explanation is in does not affect the severity of the bug. Users that see that there are two conflicting explanations in the same document might be even more confused as to which behaviour is intended. The developer guide is meant to be a source for developers to consult when they need clarification about the product. The delete command in particular is a core feature of the application, and this wrong explanation will affect many developers when they read the documentation.

Furthermore, the bug is not just a typo, it is a completely incorrect explanation. The severity of the bug could be lowered to low if it was just a typo, but in this case, it should stay at medium.