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

2단계 - 요구 사항 정리 #820

Open
wants to merge 1 commit into
base: wishoon
Choose a base branch
from
Open

Conversation

wishoon
Copy link

@wishoon wishoon commented Feb 2, 2025

안녕하세요 경록님! 다른 일정 때문에 미션 제출이 늦어졌네요 😅

이번 과제도 리뷰 잘 부탁드리겠습니다 🙌

Copy link

@Rok93 Rok93 left a comment

Choose a reason for hiding this comment

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

지훈님 개인적인 일정으로 리뷰가 조금 늦었습니다. 🙏
몇몇 코멘트 남겨두었는데, 확인해서 반영 부탁드릴게요.

요구사항 문서를 개발자만 보는 것이 아니라 함께 일하는 사람들(기획자, 도메인 전문가 etc)이 봐도 이해할 수 있도록 작성해보시면 좋을 것 같아요. 😃

### 메뉴 그룹

- [ ] 메뉴 그룹은 '메뉴 그룹명' 정보를 가진다.
- [ ] 메뉴 그룹의 '메뉴 그룹명'은 공백이거나 없을 수 없다.
Copy link

Choose a reason for hiding this comment

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

개인적으로 부정의 부정문은 잘 읽히지 않아서 이런 경우에는 가급적 긍정문으로 고쳐서 쓰려고 노력하는 편인데요.

아래와 같이 써보면 어떨까요? 🤔

Suggested change
- [ ] 메뉴 그룹의 '메뉴 그룹명'은 공백이거나 없을 수 없다.
- [ ] 메뉴 그룹의 '메뉴 그룹명'은 필수값이고 공백을 허용하지 않는다.


### 메뉴 그룹

- [ ] 메뉴 그룹은 '메뉴 그룹명' 정보를 가진다.
Copy link

Choose a reason for hiding this comment

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

메뉴 그룹이라는게 어떤건지 가볍게 설명이나 예시를 추가해줘도 좋을 것 같아요. 😃

### 상품

- [ ] 상품은 '상품명', '상품 가격' 정보를 가진다.
- [ ] 상품의 '상품명'은 공백이거나 없을 수 없다.
Copy link

Choose a reason for hiding this comment

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

상품명에 비속어도 사용이 가능할까요? 🤔

세부적인 코드들도 확인해보시고 세부적인 정책들도 요구사항에 문서에 정리해보시면 좋을 것 같아요. 😃

- [ ] 상품은 주어진 정보를 기반으로 '상품'을 생성할 수 있다.
- [ ] 상품은 '상품명', '상품 가격' 정보를 기반으로 상품을 생성할 수 있다.

- [ ] 상품은 주어진 정보를 기반으로 '상품'을 수정할 수 있다.
Copy link

Choose a reason for hiding this comment

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

상품 수정 시에 상품 외에는 영향가는 곳이 없을까요? 🤔

- [ ] 메뉴의 '메뉴 상품 목록'의 '메뉴 상품'은 '수량', '가격' 정보를 가진다.
- [ ] 메뉴 상품의 '수량'은 0 미만일 수 없다.
- [ ] 메뉴 상품의 '가격'은 0 미만일 수 없다.
- [ ] 메뉴 상품의 '가격'은 '수량'의 값을 기반으로 총합을 계산하였을 때, 메뉴의 '메뉴 가격'을 초과할 수 없다.
Copy link

Choose a reason for hiding this comment

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

(메뉴 상품의 총 가격 합)이 메뉴 가격보다 크면 안된다는 걸까요? 🤔
제가 알기로는 반대인걸로 아는데, 이 부분은 확인한번 부탁드릴게요. 🙏


- [ ] 메뉴는 주어진 정보를 기반으로 '메뉴'를 생성할 수 있다.

- [ ] 메뉴는 주어진 정보를 기반으로 '메뉴'를 수정할 수 있다.
Copy link

Choose a reason for hiding this comment

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

메뉴를 수정하는 기능이있었나요? 🤔
메뉴의 가격을 수정하는 기능을 얘기하시는거라면 오해의 소지가 있어 보이네요. 🙄


- [ ] 주문은 '주문 형식', '주문 상태', '주문 시간', '주문 상품 목록', '주문 배송지', '가게 테이블' 정보를 가진다.
- [ ] 주문의 '주문 형식'은 DELIVERY, TAKEOUT, EAT_IN 3가지 종류가 있다.
- [ ] 주문의 '주문 상태'는 WAITING, ACCEPTED, SERVED, DELIVERING, DELIVERED, COMPLETED 6가지 종류가 있다.
Copy link

Choose a reason for hiding this comment

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

각 주문 상태에 대해서도 한글로 정의해보시면 조금 더 요구사항이 읽기 쉬워질 것 같아요. 😃

- [ ] 주문은 '주문 형식', '주문 상태', '주문 시간', '주문 상품 목록', '주문 배송지', '가게 테이블' 정보를 가진다.
- [ ] 주문의 '주문 형식'은 DELIVERY, TAKEOUT, EAT_IN 3가지 종류가 있다.
- [ ] 주문의 '주문 상태'는 WAITING, ACCEPTED, SERVED, DELIVERING, DELIVERED, COMPLETED 6가지 종류가 있다.
- [ ] 주문의 '주문 시간'은 년/시/분/초 형식을 사용한다.
Copy link

Choose a reason for hiding this comment

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

음... 이런 디테일한 부분까지 정의할 필요는 없을 것 같아요.
세부적인 내용까지 요구사항 문서에 다루기 시작하면, 추후 약간의 변경에도 요구사항 문서를 일일이 수정해야할 것 같아요.


### 주문

- [ ] 주문은 '주문 형식', '주문 상태', '주문 시간', '주문 상품 목록', '주문 배송지', '가게 테이블' 정보를 가진다.
Copy link

Choose a reason for hiding this comment

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

OrderType을 '주문 형식'으로 명명하신 것 같아요.
개인적으로 Type이 종류, 유형 같은 네이밍이 조금 더 익숙한 것 같은데 주문 유형 같은 용어는 어떨까요? 🤔

- [ ] 주문의 '주문 상품 목록'은 '주문 형식'이 DELIVERY, TAKEOUT 인 경우 0 미만일 수 없다.
- [ ] 주문의 '주문 상품 목록'은 연관된 메뉴의 갯수와 동일한 갯수를 가져야 한다.
- [ ] 주문의 '주문 상품 목록'의 '주문 상품'은 '주문 상품 메뉴 정보', '주문 상품 수량', '주문 상품 가격' 정보를 가진다.
- [ ] 주문의 '주문 배송지'는 주문 형식이 DELIVERY 인 경우, 공백이거나 없을 수 없다.
Copy link

Choose a reason for hiding this comment

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

아래와 같이 변경해도 동일한 의미가 될 수 있을 것 같아요.

Suggested change
- [ ] 주문의 '주문 배송지'는 주문 형식이 DELIVERY 인 경우, 공백이거나 없을 수 없다.
- [ ] 배달 주문인 경우 '주문 배송지'는 필수 값이다.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants