search

Jnjy / pe

0 stars 0 forks source link

DG: Inconsistency in test case subheader #9

Open Jnjy opened 1 year ago

Jnjy commented 1 year ago

image.png

Would be better if provide a subheader for all the other manual test cases.

soc-se-bot commented 1 year ago

Team's Response

Hello there! Thanks for writing in.

Number 3 that you highlighted in the diagram has a subheader on purpose, because it needed to have 2 commands entered consecutively. On the other hand, the other cases only require one command, hence there is no need for a subheader.

Furthermore, the presence of this subheader does not hinder the user's readability. In fact, it provides more clarity as to what Number 3 is about, where we explain to the readers that the 2 commands are involving finding of internships through the filtered internship list. If you refer to CS2103T's website, documentation bugs are issues that make the guide harder to read/understand, but this subheader does not impact readability in any negative way.

image.png

Thus, our team would reject this as a bug. Thank you for your time.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Thank you for your response!

Number 3 that you highlighted in the diagram has a sub-header on purpose

I agree that it is highlighted on purpose as it requires 2 commands to perform the test. However, it also made it convenient for me as a reader; the sub-header explicitly told me what to look out for in the specific test but the absence in others will result in inconvenience. For instance, a developer who wants to improve your application InternBuddy reads through your test cases might find it inconvenient to have to go through all the explanations to understand each test case.

Therefore, if the team decides to add sub-headers to one of the manual test cases (which may be unavoidable in this case), it might be beneficial to add sub-headers to all other test cases as well as this approach could provide a more descriptive and organized layout for the test cases, making it easier for readers to quickly identify the specific test cases they are interested in. In short, adding sub-headers to all the other test cases will not harm your DG but inconsistency in usage of descriptive sub-header will.