jiaweiteo / pe

0 stars 0 forks source link

[UG] Prefix not explained in UG #13

Open jiaweiteo opened 3 years ago

jiaweiteo commented 3 years ago

The prefix of commands are not explicitly explained in the User guide. Users may feel unclear without know what the prefix stand for. (E.g. what is ct?)

image.png

nus-se-bot commented 3 years ago

Team's Response

Under notes about command format in the user guide, it was mentioned in the first line, with the example of delete command, that ct stands for TYPE.

image.png

In most cases, users would have read the notes about command format before reading through the entire user guide. Hence, they would have an understanding of what the prefix for ct meant. Besides ct/ prefix, meaning of all other prefixes could be seen in the relevant section of the user guide, for example, n/NAME, implying that the prefix n stands for name.

Furthermore, not knowing what the prefixes mean does not affect the user's usage of CLI-nic. This is so as the commands have been split up according to suppliers and warehouses in the user guide, where ct/s and ct/w was used respectively for each section. Users can copy from the user guide, or use the autocomplete feature in CLI-nic to help them complete their relevant commands.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]