search

yadunut / pe

0 stars 0 forks source link

More images in the userguide #10

Open yadunut opened 7 months ago

yadunut commented 7 months ago

Not enough visuals on the command usage in the userguide. It would be good to show the success and failure case for some of the more commonly used commands and how to get out of them.

soc-pe-bot commented 7 months ago

[IMPORTANT!: Please do not edit or reply to this comment using the GitHub UI. You can respond to it using CATcher during the next phase of the PE]

Team's Response

We feel that including too many visuals will make the user guide too lengthy, which can hurt the user experience when using the guide. In addition, our error messages should be able to inform the user what was wrong with their commands, hence we do not think that it is necessary to include more images in the guide as it might hurt more than it helps.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [replace this with your reason]

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your reason]