adam-ky / pe

0 stars 0 forks source link

Missing preamble and figure caption for screen shots used #13

Open adam-ky opened 2 years ago

adam-ky commented 2 years ago

I believe the screenshots used should be relevant and explained to readers what it's trying to illustrate. However, for example, the image below shows missing figure caption and explanation for the screenshot.

image.png

This is true for all the features with a screenshot to illustrate the expected outcome.

nus-pe-bot commented 2 years ago

Team's Response

Are you able to provide details on any of the non-relevant screenshots? Each command has one screenshot attached and there is no ambiguity on which command was executed. Furthermore, the exact command used in the screenshot was picked from the examples provided, which does include a brief description and the result of the command is shown clearly.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: My bad, I realised it's wrong of me to imply the screenshots were irrelevant, when in fact they are. What I meant was that the screenshot doesn't flow well with the content when there isn't a preamble to lead the readers into it. It's kind of just there. Also, you mentioned that the screenshot was picked from the examples provided below, which is not really true as shown in the screenshot below. deletec m/CS1231 used in the screenshot is not in the example.

image.png

I think one possible way to bypass this issue is to explain to readers in your "How to use this User Guide" that a screenshot will be provided after one of the examples picked out to show the expected outcome. Or simply add a preamble before each screenshot to be explicit.


:question: Issue severity

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

Reason for disagreement: As this is not a purely cosmetic issue, I suggest to lower it to severity.Low instead.