search

alanlowzies / pe

0 stars 0 forks source link

UG - Insufficient description of `add` command parameters #12

Open alanlowzies opened 2 years ago

alanlowzies commented 2 years ago

In particular, perhaps the {vacancies} parameter could have a description to describe what kind of vacancy.

As a new user, I was a bit confused when I saw that {vacancies} parameter without any description of it.

nus-pe-bot commented 2 years ago

Team's Response

An employee of the travel agency would know that vacancies refer to the spots available for people to sign up in the package.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: It is not safe to assume that all travel agency staff, let alone all users of the application, will immediately understand the parameter {vacancies} when reading the user guide for the add command.

The user guide should not leave room for ambiguity and should at least describe every parameter in the command so that the user completely understands the command.