search

L-K-Chng / pe

0 stars 0 forks source link

The UserGuide parameters are not explicitly stated to readers #11

Open L-K-Chng opened 1 year ago

L-K-Chng commented 1 year ago

It would be good to explain to readers that the parameter within the [ ] is a parameter that requires to be input by users. This is because it may not be the same for all User Guides. For example, in AB3, the parameters within square brackets are parameters which can be excluded by the user. Hence, when readers first read the UG taking AB3 as reference, they might think that this input within a square bracket is something which can be omitted by them.

image.png

nus-se-bot commented 1 year ago

Team's Response

We tried to make it clear that bracketed words are fields to be changed. Sorry! We will improve in the next update.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Since you recognise this as an issue to be improved, then shouldn't this be treated as a documentation bug? Users should know about the command format so they know the requirements for each of the parameters (eg. whether the parameter they input is optional or not), hence this should be a documentation bug.