search

nramapurath / pe

0 stars 0 forks source link

DG: Use cases missing #10

Open nramapurath opened 1 year ago

nramapurath commented 1 year ago

The DG lacks use cases for the show, find and clear commands.

nus-pe-bot commented 1 year ago

Team's Response

The 'show' command is covered under the 'see all applications' use case. The 'clear' command is covered under the 'delete an opening' use case. The only command whose use case was not properly covered in the DG is the 'find' command. Even then, this documentation bug should not be a medium, since it does not inconvenience users at all. The documentation bug should be a very low at best.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: I believe the devs may have confused my mention of 'Use cases' with 'User stories'. While the user stories do provide one-liner descriptions of what the product aims to provide to users, the use cases for the commands I mentioned are missing. Readers of the guide would not be able to understand the expected behavior of the product under these commands without these use cases being covered.

I do believe this should be a Medium severity bug as this is lacking description for what I would say are core features of this product. I disagree with the devs' chosen severity of veryLow as this is not merely a cosmetic bug.