search

dickongwd / pe

0 stars 0 forks source link

Unintuitive command names #5

Open dickongwd opened 10 months ago

dickongwd commented 10 months ago

The app has separate command names for volunteers and events, like vcreate and ecreate, which is fine.

However it starts to get confusing when the command names become elistv, vliste, eremovev (but no vremovee?). Makes it difficult to test for a someone who is completely new to the app.

Moreover, some commands need us to specify the flag eid/, while some doesnt require to. For example, eedit does not require the index to be in the flag eid/ while the command eaddv requires the index to be in the flag eid/.

nus-pe-bot commented 10 months ago

Team's Response

When we designed the app, we tried to ensure the app usage to be as simplified as possible due to the complexity of our app's features and event-volunteer interactions. For example, when the command name is elistv, it stands for "event list volunteers". Likewise for vliste, it stands for "volunteer list events".

For vremovee, it doesn't make sense due to the logic above so we never implemented it.

The eid/ flag for event-volunteer interaction commands like eaddv part is intentional and necessary in order for us to differentiate between the volunteer and event IDs. For event-only commands like eedit, it only targets one event so there is no need to specify the type of index (eid/).

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I think "event list volunteers" or "volunteer list events" is not very intuitive/doesn't make a lot of sense, either.

Like how eremovev removes a volunteer from an event to signal that the event has lost a volunteer (from the perspective of the event), vremovee also makes sense because it signals that the volunteer has left the event (from the perspective of the volunteer).

The team says that commands like eedit only targets one event and so there is no need for eid/. However, commands like eaddv also only targets one event. It isn't clear why there is a need for eid/ flag in eaddv. I am trying to suggest that commands like eaddv can follow the format eaddv 1 vid/1 so that all event commands (commands that start with 'e') are consistent in their format.