search

woojiahao / pe

1 stars 0 forks source link

Lack of commands under "Instructions for manual testing" #25

Open woojiahao opened 10 months ago

woojiahao commented 10 months ago

Not every command is covered in the instructions like find

soc-se-bot commented 10 months ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

The manual testing in the dg does not showcase every feature.

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

No details provided by bug reporter.

[original: nus-cs2103-AY2324S1/pe-interim#5951] [original labels: type.DocumentationBug severity.VeryLow]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Thanks for pointing this issue out. It is true that we missed out some features for manual testing in the DG.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** While I agree that this is a duplicate issue, **VeryLow** should only be reserved for cosmetic issues. However, missing information means that the overall usability/usefulness of the DG is lowered as the users are not aware of the other available commands. This is critical as on first read, I had also missed that the team had other commands available (given that the PE instruction was to first follow the manual testing instructions). As a result, this goes beyond a cosmetic issue and should have a severity of at least **Low** as I had originally indicated. ![Screenshot 2023-11-22 at 11.17.14.png](https://raw.githubusercontent.com/woojiahao/pe/main/files/5174a3a8-4a7a-49fd-ab19-b5df26d8a6fd.png) The instructions only contains information for 9 out of the 17 commands supported in the UG, meaning that it is missing nearly half of the available commands for users to use. This goes against the instructions given for this section: ![Screenshot 2023-11-22 at 12.45.34.png](https://raw.githubusercontent.com/woojiahao/pe/main/files/ac605f7f-9bc1-4cd2-a3e3-b56cd4de85f4.png)