search

jiexiong-zeng / pe

0 stars 0 forks source link

UG mismatch in instructions #3

Open jiexiong-zeng opened 2 years ago

jiexiong-zeng commented 2 years ago

Inside the help command, to set alert thresholds, the command is set ALERT_TYPE VALUE. However, in the UG section 2.10, the command given is set [TYPE] [NEW_VALUE].

image.png

To edit current date the command is date DATE, but in section 2.11, the command given is date [NEW_DATE].

image.png

nus-se-script commented 2 years ago

Team's Response

It is quite clear in the section what the type is referring to when using that particular command

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: set ALERT_TYPE VALUE vs set [TYPE] [NEW_VALUE]
date DATE vs date [NEW_DATE]

The developer team is using different names for the same variable. This can result in confusion for users.

:question: Issue severity

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

Reason for disagreement: This can affect usage and cause inconvience.