search

Jarrod-Bob / pe

0 stars 0 forks source link

Incorrect command examples given #11

Open Jarrod-Bob opened 4 years ago

Jarrod-Bob commented 4 years ago

image.png

You might have missed out a space in the Setting Up portion of your guide for most of the commands as shown in the image above. Users will face difficulties when trying to use the UserGuide for setup and trying out.

nus-pe-bot commented 4 years ago

Team's Response

image.png

Issue was a result of formatting issues.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: It could be due to formatting issues, but we need not necessarily press convert to pdf for any of these, we may try to instead convert from HTML. It is not justifiable enough to simply blame this on formatting. The onus is on the developers to make sure the guide is proper, especially for users who may not be the most tech savvy about these issues.

:question: Issue severity

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

Reason for disagreement: Given that most technology users depend on the starting up guide to test out, I believe it is beyond just a small typo mistake that was made. The inability to use this application from the get-go could render users to not use the app further. Upon second look, this may not be a medium, but it warrants a Low at least.