riccqi / pe

1 stars 0 forks source link

Inconsistent naming of Inventory, Item and Stock #9

Open riccqi opened 1 year ago

riccqi commented 1 year ago

The app GUI uses the label "Inventory" for all the items with their stock levels. The editStock command refers to these items as "Stock", while the addItem command refers to them as "Items".

This is quite confusing naming, as there is no consistency and the user might not know intuitively how to refer to these items in different contexts.

Screenshot 2022-11-11 at 4.57.54 PM.png Screenshot 2022-11-11 at 4.58.03 PM.png

Screenshot 2022-11-11 at 4.58.11 PM.png

nus-pe-bot commented 1 year ago

Team's Response

Response

Team chose [response.Rejected]

Reason for disagreement: Though I see the point of the team, and now better understand why they used the terms Stock, Item, and Inventory in different contexts, I still strongly believe the naming can be improved. My suggestion for better naming of the commands could simply be:

image.png addItem -> addInventory (addItem is very vague and can be confusing even for food vendors)

Screenshot 2022-11-15 at 5.20.08 PM.png

editStock -> editInventory (Using the editInventory naming can even allow the edit function for inventory items to be more extensible in the future.)

While the target audience are NUS food vendors, some of them could be foreigners who are less well-versed with english. The team should not use the target audience as excuse for not using more consistent and understandable naming in their application. Why complicate when you can be simple?


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]