search

wpx12011 / pe

0 stars 0 forks source link

UG, unclear explanation in Windows and Features Overview #9

Open wpx12011 opened 1 year ago

wpx12011 commented 1 year ago

image.png

Last line in Windows and Features Overview, should specify where is the 'corresponding button' or insert a screenshot to aid explanation.

nus-pe-script commented 1 year ago

Team's Response

We have explained it exclusively in each section (and we have also attached the hyperlinks for each section in the overview for clearer instructions).

image.png

We feel that if we include all the buttons in the overview, it would not be an overview anymore but rather a detailed instruction - which is not the purpose of an overview. Moreover, as our product is supposed to focus on typing-preferred user, we believe the commands is more important than the GUI mode and thus decide not to "dive deep" into the GUI mode in the overview, else the overview is gonna be very lengthy.

Also, when the user opens the app, it should be quite clear what buttons the documentation is referring to.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: image.png

I do not agree with the team's rejection to my issue.

While the team is arguing that "Moreover, as our product is supposed to focus on typing-preferred user, we believe the commands is more important than the GUI mode and thus decide not to "dive deep" into the GUI mode in the overview", the team's product has a pretty complicated GUI interface (please refer to the screenshot attached) which could confuse the user without clear explanation.

As a response to the team's argument "Also, when the user opens the app, it should be quite clear what buttons the documentation is referring to." I find it's difficult to match the documentaion of CLI commands with the GUI interface. For example, list_reminder is a CLI command to open reminder list, but there is no corresponding button to open the reminder window.

Therefore, I think it is reasonable to raise this issue as unclear documentation with serverity.Low to remind the team that there is no "simply click on the corresponding button" as the buttons are not exact correspondence of the commands listed above.