From f09978901408a06ca4339e0c1c065d338f3f4c84 Mon Sep 17 00:00:00 2001 From: kimjio Date: Sun, 2 Jun 2024 22:18:44 +0900 Subject: [PATCH] =?UTF-8?q?doc(README):=20=ED=82=A4=EC=B9=9C=ED=8F=AC?= =?UTF-8?q?=EC=8A=A4=20=EC=9A=A9=EC=96=B4=20=EC=82=AC=EC=A0=84=20=EB=A7=8C?= =?UTF-8?q?=EB=93=A4=EA=B8=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 82 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 79 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index eb929c006..2aed9ff9d 100644 --- a/README.md +++ b/README.md @@ -96,8 +96,84 @@ docker compose -p kitchenpos up -d ## 용어 사전 -| 한글명 | 영문명 | 설명 | -| --- | --- | --- | -| | | | +### 공통 + +| 한글명 | 영문명 | 설명 | +|------|------------|---------------| +| 비속어 | profanity | 욕설 또는 저속한 표현. | + +### 상품 + +| 한글명 | 영문명 | 설명 | +|------|---------------|------------------------------------| +| 상품 | Product | 고객에게 판매를 목적으로 보유한 물건으로 메뉴를 구성하는 단위 | +| 상품이름 | Product Name | 상품의 이름, 비속어를 사용할 수 없다. | +| 상품가격 | Product Price | 상품의 가격, 0원 이상이여야 한다. | + +### 메뉴그룹 + +| 한글명 | 영문명 | 설명 | +|----------|-----------------|--------------------------------| +| 메뉴 그룹 | Menu Group | 메뉴의 집합이며, 메뉴는 특정한 메뉴그룹에 속해야한다. | +| 메뉴 그룹 이름 | Menu Group Name | 메뉴 그룹의 이름, 비속어를 사용할 수 없다. | + +### 메뉴 + +| 한글명 | 영문명 | 설명 | +|----------|----------------|------------------------------| +| 메뉴 | Menu | 상품의 집합이며, 1개 이상의 상품으로 구성된다. | +| 메뉴 이름 | Menu Name | 메뉴의 이름, 비속어를 사용할 수 없다. | +| 메뉴 가격 | Menu Price | 메뉴의 가격, 0원 이상이여야 한다. | +| 메뉴 상품 | Menu Product | 상품과 수량으로 구성된다. | +| 메뉴 공개 상태 | Menu Displayed | 메뉴의 공개 상태를 나타낸다. ex) 공개, 비공개 | + +### 주문테이블 +| 한글명 | 영문명 | 설명 | +|-----------|------------------|--------------------------------| +| 주문 테이블 | Order Table | 매장 내에서 고객이 식사할 수 있는 테이블을 나타낸다. | +| 주문 테이블 이름 | Order Table Name | 테이블의 이름, 비속어를 사용할 수 없다. | +| 주문 테이블 인원 | Number Of Guests | 주문 테이블을 사용하는 고객의 수를 나타낸다. | +| 테이블 점유 상태 | Occupied | 테이블의 점유 상태를 나타낸다. ex) 점유, 미점유 | + +### 주문 + + | 한글명 | 영문명 | 설명 | + |---------|------------------|--------------------------------------------------------------------| + | 주문 | Order | 고객이 주문한 상품정보를 나타낸다. | + | 주문 아이템 | Order Line Item | 고객이 주문한 상품 목록 정보(메뉴, 수량). | + | 주문 가격 | Order Line Price | 주문한 메뉴의 총 가격. | + | 주문 종류 | Order Type | 주문의 타입은 배달 주문(TAKEOUT), 포장 주문(TAKEOUT), 매장 주문(EAT_IN) 3가지 종류을 갖는다. | + +#### 배달 주문(Delivery Order) +| 한글명 | 영문명 | 설명 | +|---------------|------------------|---------------------------| +| 주문 종류(배달) | DELIVERY | 배달 주문 종류. | +| 주문 상태(접수 대기중) | WAITING | 배달 주문이 접수완료 되기 전 상태. | +| 주문 상태(접수 완료) | ACCEPTED | 배달 주문이 접수완료된 상태. | +| 주문 상태(서빙 완료) | SERVED | 배달 주문이 서빙완료 상태. | +| 주문 상태(배달 중) | DELIVERING | 배달 주문이 배달중인 상태. | +| 주문 상태(배달 완료) | DELIVERED | 배달 주문이 배달완료인 상태. | +| 주문 상태(주문 완료) | COMPLETED | 배달 주문이 완료된 상태. | +| 배달 대행사 | Delivery Agent | 주문을 배달해 주는 서비스를 제공하는 대행사. | +| 배달 주소 | Delivery Address | 배달 주소. | + +#### 포장 주문(TakeOut Order) +| 한글명 | 영문명 | 설명 | +|---------------|-----------|--------------------| +| 주문 종류(포장) | TAKEOUT | 포장 주문 종류. | +| 주문 상태(접수 대기중) | WAITING | 포장 주문이 접수되기 전 상태. | +| 주문 상태(접수 완료) | ACCEPTED | 포장 주문이 접수 완료된 상태. | +| 주문 상태(서빙 완료) | SERVED | 포장 주문을 수령 가능한 상태. | +| 주문 상태(주문 완료) | COMPLETED | 포장 주문을 수령한 상태. | + +#### 매장 주문(EatIn Order) +| 한글명 | 영문명 | 설명 | +|---------------|-----------|--------------------------| +| 주문 종류(매장) | EAT_IN | 매장 주문 종류. | +| 주문 상태(접수 대기중) | WAITING | 매장 주문이 접수되기 전 상태. | +| 주문 상태(접수 완료) | ACCEPTED | 매장 주문이 접수 완료된 상태. | +| 주문 상태(서빙 완료) | SERVED | 매장 주문이 매장 테이블에 서빙완료된 상태. | +| 주문 상태(주문 완료) | COMPLETED | 매장 주문이 완료된 상태. | + ## 모델링