Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

1단계 - 용어 사전 만들기 #451

Merged
merged 7 commits into from
Feb 9, 2025
Merged
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 56 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,61 @@ docker compose -p kitchenpos up -d

## 용어 사전

| 한글명 | 영문명 | 설명 |
| --- | --- | --- |
| | | |
### 공통 용어
| 한글명 | 영문명 | 설명 |
|--------|---------|------------------------------------|
| 등록 | create | 메뉴나 상품 등의 지정한 정보를 저장소에 저장하는 것을 말한다 |
| 비속어 | profanity | 사용하기에 부적합한 욕설과 같은 단어들을 말한다 |

### 상품
| 한글명 | 영문명 | 설명 |
|-------|---------------|---------------------------------------|
| 상품 | product | 메뉴를 구성하는 제품. 후라이드 치킨이나 음료와 같은 품목을 말한다 |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

예시와 함께 작성해주니 상품 이라는 용어에 대해 더 이해하기 쉬운것 같아요 👍

| 상품 이름 | name | 상품을 부르는 명칭 |
| 상품 가격 | price | 상품을 구매하기 위해 지불해야 할 가격 |

### 메뉴
| 한글명 | 영문명 | 설명 |
|-------|--------------|---------------------------------|
| 메뉴 | menu | 1개 이상의 메뉴 상품으로 구성된 주문의 단위 |
| 메뉴 이름 | name | 메뉴를 부르는 명칭 |
| 메뉴 가격 | price | 메뉴를 구매하기 위해 지불해야 할 가격 |
| 메뉴 노출 | display | 손님이 주문할 수 있게 식당에서 메뉴가 보이는 상태 |
| 메뉴 숨김 | hide | 손님이 주문할 수 없게 식당에서 메뉴가 숨겨진 상태 |
| 메뉴 상품 | menu product | 메뉴를 구성하는 상품과 그 상품의 갯수를 표현하는 단위 |

### 메뉴 그룹

| 한글명 | 영문명 | 설명 |
|----------|------------|-----------------|
| 메뉴 그룹 | menu group | 메뉴를 구분할 수 있는 집합 |
| 메뉴 그룹 이름 | name | 메뉴 그룹을 부르는 명칭 |

### 주문 테이블
| 한글명 | 영문명 | 설명 |
|-----------|------------------|-------------------------------|
| 주문 테이블 | order table | 식당에서 주문을 받기 위해 사용하는 테이블 |
| 주문 테이블 이름 | name | 주문 테이블을 부르는 명칭 |
| 빈 테이블 해지 | sit | 비어있는 테이블에 손님이 착석하는 것을 말한다 |
| 빈 테이블 설정 | clear | 테이블을 손님이 착석할 수 있게 정리하는 것을 말한다 |
| 손님 수 | number of guests | 테이블에 착석한 손님 수 |

### 주문
| 한글명 | 영문명 | 설명 |
|--------|------------------|---------------------------------------|
| 주문 | order | 손님이 식당에서 구매한 메뉴들 또는 메뉴들을 구매하는 행위를 말한다 |
| 주문 유형 | order type | 손님의 주문을 어떻게 제공할지를 말한다 |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

주문 유형에는 어떤 것이 있는지 같이 정리하면 좋을 것 같아요
배달 주문, 포장 주문, 매장 주문에서 이미 주문 유형이라는 표현이 있지만, 한눈에 주문 유형에는 무엇이 있는 지 정리해주는게 더 빠르게 이해할 수 있을 것 같아요

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

같이 적어주는게 이해하기는 더 좋겠네요.
이런 유형의 설명이 enum 같은 것이라고 생각하는데요, 유형이 추가될 때마다 주문 유형 설명도 같이 수정해주지 않으면 언젠가는 누락될 것 같습니다(db의 type 같은 컬럼에 유형을 comment로 적어두는데, 서비스가 발전하다보면 항상 누락되더라고요).
아예 주문 유형이라는 새로운 타이틀을 빼고 그 곳에 용어들을 전부 빼두면 될 것 같은데 어떠세요?
유형을 이야기하신 것처럼 설명에 적어주지 않아도 읽는 사람이 이해하기 쉽고 신규로 주문 유형이 추가되어도 누락되지 않을 것 같아요.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DM 으로 이야기했던 부분이여서 머지할게요!

| 배달 주문 | DELIVERY | 손님이 주문한 메뉴들을 배달을 통해 전달해야 하는 주문 유형 |
| 포장 주문 | TAKEOUT | 손님이 주문한 포장된 메뉴들을 직접 가게에서 수령하는 주문 유형 |
| 매장 주문 | EAT_IN | 손님이 주문 테이블에서 직접 식사하는 주문 유형 |
| 배달 주소 | delivery address | 배달 주문이 배달되어야 할 손님의 주소 |
| 배달 대행사 | delivery agency | 배달 라이더를 관리하고 파견해주는 회사 |
| 배달 라이더 | rider | 배달 주문을 배달 주소로 전달해주는 사람 |
| 등록 | WAITING | 손님이 가게에 주문을 요청한 상태 |
| 접수 | ACCEPTED | 손님의 주문을 식당에서 확인하여 확정된 상태 |
| 서빙 | SERVED | 손님의 주문이 완성되어 나온 상태 |
| 배달 | DELIVERING | 서빙된 주문이 배달 라이더를 통해 배달중인 상태 |
| 배달 완료 | DELIVERED | 배달중이었던 주문이 배달이 완료되어 배달 주소로 전달된 상태 |
| 완료 | COMPLETED | 주문이 최종적으로 손님에게 전달된 상태 |

## 모델링