search

TohWeiJie01 / pe

0 stars 0 forks source link

Help command documentation #22

Open TohWeiJie01 opened 2 years ago

TohWeiJie01 commented 2 years ago

image.png

image.png

In the UG, there is only one way to access the help command, however, in the DG, there seems to be multiple ways to do so, in that case, it should be added in the UG as well.

nus-pe-bot commented 2 years ago

Team's Response

UG only talks about CLI commands to be inputted. tApp is specified to be for CLI input. The help button is to complement the CLI tApp application, and is prominently displayed and intuitive for a user in the GUI. Hence there is no need to specify it.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I disagree as the UG and DG should be consistent between the two. It does not make sense if you provide manual testing of the help feature by interaction with the clicking of the buttons, but don't include it in the UG, which is the actual document to help the user learn how to use the application.