Samuel-bit-prog / pe

0 stars 0 forks source link

Some of the commands in the ug could benefit from visuals. #6

Open Samuel-bit-prog opened 2 years ago

Samuel-bit-prog commented 2 years ago

Not enough visuals for certain commands.

image.png For example, taking notes does not have any picture to show the window-pop up. You also have to click save to save the note but it is not stated in the user guide on how to do this. I thought have to press enter after typing in the popup to save but it did not work until I found the save button. Could be better explained with more steps and picture. Chose low as it is unlikely to affect normal operations of the product. Appears only in very rare situations and causes a minor inconvenience only. It is not a cosmetic issue thus not very low.

nus-pe-bot commented 2 years ago

Team's Response

While it could be clearer to have it here in the user guide, instructions on how to save the note via CLI are within the user guide if you scroll down. Additionally, it is intuitive to click "save" to save, so it is not necessary to explain in the UG.

Screenshot from UG: Screenshot 2021-11-15 at 3.35.23 PM.png

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]