avellinwong01 / pe

0 stars 0 forks source link

DG: Instructions for manual testing section is too long #21

Open avellinwong01 opened 2 years ago

avellinwong01 commented 2 years ago

The instructions for manual testing section take up ~50% of your DG length. I don't think it is necessary to have so much detail of all the different test cases, sample inputs and expected outputs -- it makes it overlap with the UG and there's way too much detail, making it overwhelming.

nus-se-bot commented 2 years ago

Team's Response

The manual testing is long because it shows expected outputs of invalid commands, or cases not specified in the UG since the UG focuses on valid inputs. As stated, the DG should compliment the UG which is why things like error messages for invalid inputs are focused on in the DG instead. Furthermore, since we have a lot of commands, the section is naturally longer. As such, we do not think there is a significant overlap between the UG and DG nor redudant information in the manual testing section.

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]

Reason for disagreement: Don't think this is merely a cosmetic issue as this affects other developers in their testing of the product. I would say more of low severity.