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

wishoon · 2025-02-02T07:43:53Z

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

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

Rok93

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

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

Rok93 · 2025-02-03T11:04:40Z

README.md

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


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

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

Suggested change

- [ ] 메뉴 그룹의 '메뉴 그룹명'은 공백이거나 없을 수 없다.

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

네네 좋습니다 🙌

Rok93 · 2025-02-03T11:05:10Z

README.md

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


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

Rok93 · 2025-02-03T11:16:25Z

README.md

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


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

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

Rok93 · 2025-02-03T11:18:08Z

README.md

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


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

상품 수정 시 메뉴에 영향이 가게 됩니다!

제가 상품 쪽에 요구사항을 적지 않고 메뉴 쪽에 요구사항을 작성한 이유는 상품이 메뉴의 도메인을 알 필요가 없다고 생각해서 입니다. 상품은 정보를 변경할 뿐, 변경된 이벤트를 바탕으로 메뉴가 변경이 되는 것이 더 자연스러운 흐름이라고 생각하게 되어 메뉴 쪽에 요구사항을 작성했습니다

Rok93 · 2025-02-03T11:21:52Z

README.md

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


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

아이고.. 반대로 작성했네요 매의 눈 👀 리뷰 감사합니다

Rok93 · 2025-02-03T11:22:51Z

README.md

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


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

아하 보통 저는 요구사항을 작성할 때 대분류, 소분류로 나눠서 작성하는 것을 선호하긴 합니다.

예를 들면, A 도메인에 상품을 생성하고 가격을 수정하는 기능이 있다고 한다면, 대분류를 생성(C), 수정(U)으로 1차 분류합니다. 이후, 수정이라는 분류 중에서 가격을 수정하고, 전시 여부를 수정하는 하위 요구사항을 서술하는 편이긴 합니다!

추가적으로 제가 메뉴 가격 수정 요구사항을 빠트렸네요;; 이 이유 때문에 요구사항이 더 애매하게 보였던 것 같긴하네영 ㅎㅎ

(혹시 위 부분에 대해서는 어떻게 생각하시나요 ㅎㅎ 경록님 팀에서는 요구사항 작성 시 포멧을 따로 가져가시는지 궁금하네여)

이 방식도 괜찮은 것 같아요!
사실 대다수의 기능이 수정쪽으로 몰릴 것 같아서 사실 이 C,U,D로 구분하는게 큰 의미가있을까 싶기도하고
그 외에도 생각해보면 이런 CRUD 구분법은 개발자에게 친숙한 방식인 것 같다는 생각이 들기도하네요. 🤔

또 마이너하지만 전체적으로 뎁스가 하나씩 추가되는건데, 뎁스가 깊어지다보니 가독성이 조금 떨어질 수 있을 것 같다는 생각이들기는해요.

Rok93 · 2025-02-03T11:31:34Z

README.md

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


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

요것도 말씀해주신 것 처럼, 타 직군이 보시기에 한글로 용어를 통일해서 사용하는게 더 적절해 보이네요 ㅎㅎ

Rok93 · 2025-02-03T11:32:23Z

README.md

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


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

Rok93 · 2025-02-03T11:34:12Z

README.md

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


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

아하 넵넵 형식보다는 타 직군에 계신 분들이 보시기에 종류, 유형이 더 적절한 용어로 보이네요. 반영해서 수정해두겠습니다

Rok93 · 2025-02-03T11:35:02Z

README.md

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


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

Suggested change

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

- [ ] 배달 주문인 경우 '주문 배송지'는 필수 값이다.

문서를 조금 더 타 직군이 잘 이해할 수 있도록 말씀해주신 방향으로 변경해볼게요 ㅎㅎ

wishoon

이번 주 다른 업무 때문에 리뷰 반영이 많이 늦었네요 ㅠ 꼼꼼한 리뷰 감사합니다.

코멘트 주신 부분 반영하였는데 한번 확인 부탁드립니다 ㅎㅎ

wishoon · 2025-02-08T05:10:53Z

README.md

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


상품 수정 시 메뉴에 영향이 가게 됩니다!

제가 상품 쪽에 요구사항을 적지 않고 메뉴 쪽에 요구사항을 작성한 이유는 상품이 메뉴의 도메인을 알 필요가 없다고 생각해서 입니다. 상품은 정보를 변경할 뿐, 변경된 이벤트를 바탕으로 메뉴가 변경이 되는 것이 더 자연스러운 흐름이라고 생각하게 되어 메뉴 쪽에 요구사항을 작성했습니다

wishoon · 2025-02-08T05:12:14Z

README.md

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


아이고.. 반대로 작성했네요 매의 눈 👀 리뷰 감사합니다

wishoon · 2025-02-08T05:19:58Z

README.md

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


아하 보통 저는 요구사항을 작성할 때 대분류, 소분류로 나눠서 작성하는 것을 선호하긴 합니다.

예를 들면, A 도메인에 상품을 생성하고 가격을 수정하는 기능이 있다고 한다면, 대분류를 생성(C), 수정(U)으로 1차 분류합니다. 이후, 수정이라는 분류 중에서 가격을 수정하고, 전시 여부를 수정하는 하위 요구사항을 서술하는 편이긴 합니다!

추가적으로 제가 메뉴 가격 수정 요구사항을 빠트렸네요;; 이 이유 때문에 요구사항이 더 애매하게 보였던 것 같긴하네영 ㅎㅎ

(혹시 위 부분에 대해서는 어떻게 생각하시나요 ㅎㅎ 경록님 팀에서는 요구사항 작성 시 포멧을 따로 가져가시는지 궁금하네여)

wishoon · 2025-02-08T05:22:19Z

README.md

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


아하 넵넵 형식보다는 타 직군에 계신 분들이 보시기에 종류, 유형이 더 적절한 용어로 보이네요. 반영해서 수정해두겠습니다

wishoon · 2025-02-08T05:23:20Z

README.md

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


요것도 말씀해주신 것 처럼, 타 직군이 보시기에 한글로 용어를 통일해서 사용하는게 더 적절해 보이네요 ㅎㅎ

wishoon · 2025-02-08T05:34:41Z

README.md

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


네네 좋습니다 🙌

wishoon · 2025-02-08T05:35:40Z

README.md

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


문서를 조금 더 타 직군이 잘 이해할 수 있도록 말씀해주신 방향으로 변경해볼게요 ㅎㅎ

Rok93

지훈님 피드백 반영 잘해주셨네요. 👍👍
몇가지 더 짚고 넘어가면 좋을부분이있어 코멘트 남겨두었습니다. 😃
확인해서 반영 부탁드릴게요. 🙏

Rok93 · 2025-02-09T07:52:47Z

README.md

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


이 방식도 괜찮은 것 같아요!
사실 대다수의 기능이 수정쪽으로 몰릴 것 같아서 사실 이 C,U,D로 구분하는게 큰 의미가있을까 싶기도하고
그 외에도 생각해보면 이런 CRUD 구분법은 개발자에게 친숙한 방식인 것 같다는 생각이 들기도하네요. 🤔

또 마이너하지만 전체적으로 뎁스가 하나씩 추가되는건데, 뎁스가 깊어지다보니 가독성이 조금 떨어질 수 있을 것 같다는 생각이들기는해요.

Rok93 · 2025-02-09T07:59:49Z

README.md

+      - [ ] 주문의 '주문 유형'이 배달이면서 주문의 '주문 상태'가 배달 완료가 아닌 경우, 주문의 '주문 상태'를 주문 완료로 수정할 수 있다.
+      - [ ] 주문의 '주문 유형'이 포장 또는 매장식사 이면서 주문의 '주문 상태'가 서빙 완료가 아닌 경우, 주문의 '주문 상태'를 주문 완료로 수정할 수 없다.


주문 상태 수정 쪽은 정리해주신 요구사항들이 한 눈에 잘 안들어오는 것 같은데, 조금 더 요구사항들을 다듬어보면 어떨까요? 🤗
작성하신 내용들을 소리내어 읽어보시면 요구사항을 더 깔끔하게 정리하는데 도움이되실거에요. 😉

예시로 아래와 같이 변경해볼 수도 있지 않을까요? 😃

Suggested change

- [ ] 주문의 '주문 유형'이 배달이면서 주문의 '주문 상태'가 배달 완료가 아닌 경우, 주문의 '주문 상태'를 주문 완료로 수정할 수 있다.

- [ ] 주문의 '주문 유형'이 포장 또는 매장식사 이면서 주문의 '주문 상태'가 서빙 완료가 아닌 경우, 주문의 '주문 상태'를 주문 완료로 수정할 수 없다.

- [ ] 배달주문인 경우 배달 완료 상태에서만 주문 완료를 할 수 있다.

- [ ] 매장식사 주문인 경우 서빙 완료 상태에서만 주문 완료를 할 수 있다.

'주문 상태 수정'쪽 외에도 요구사항의 길이가 긴 내용들은 한번쯤 같이 더 개선할 방법이 없는지 같이 확인해주시면 좋을 것 같아요.

Rok93 · 2025-02-09T08:02:29Z

README.md

+  - [ ] 메뉴는 '메뉴 노출 여부'를 수정할 수 있다.
+    - [ ] 다른 특별한 조건 없이 숨김 상태로 수정할 수 있다.
+    - [ ] 메뉴의 '메뉴 가격'이 메뉴의 '메뉴 상품'과 연관된 상품의 '상품 가격'의 총합을 초과하지 않은 경우, 노출 상태로 변경할 수 있다.
+    - [ ] 메뉴의 '메뉴 상품'과 연관된 상품의 '상품 가격'의 변경으로 인해 메뉴의 '메뉴 상품'들의 총합이 메뉴의 '메뉴 가격'의 금액을 초과하는 경우, 숨김 상태로 변경해야 한다.


사소할 수 있겠지만 개인적으로 연관된보다는 포함된의 의미가 조금 더 직관적이지 않을까 싶어요.

Rok93 · 2025-02-09T08:05:43Z

README.md

+  - [ ] 주문의 '주문 유형'은 DELIVERY(배달), TAKEOUT(포장), EAT_IN(매장 식사) 3가지 종류가 있다.
+  - [ ] 주문의 '주문 상태'는 WAITING(주문 대기), ACCEPTED(주문 수락), SERVED(서빙 완료), DELIVERING(배달 중), DELIVERED(배달 완료), COMPLETED(주문 완료) 6가지 종류가 있다.
+  - [ ] 주문의 '주문 상품 목록'은 '주문 유형'이 배달 또는 포장인 경우 0 미만일 수 없다.
+  - [ ] 주문의 '주문 상품 목록'은 연관된 메뉴의 갯수와 동일한 갯수를 가져야 한다.


이게 무슨 말인지 잘 이해하지 못했는데 어떤 의미인지 설명해주실 수 있을까요?

docs(kitchenpos): document basic requirements

bc4c091

Rok93 requested changes Feb 3, 2025

View reviewed changes

wishoon added 5 commits February 8, 2025 14:54

docs(kitchenpos): add explanations for domain specific terms

67ef7a5

docs(kitchenpos): modify the negative sentences into positive sentences.

d7f79cb

docs(kitchenpos): add requirements

d1c8b43

docs(kitchenpos): modify the requirements in korean

8af8f12

docs(kitchenpos): modify the requirements

7ded8c1

wishoon commented Feb 8, 2025

View reviewed changes

Rok93 requested changes Feb 9, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

wishoon commented Feb 2, 2025

Rok93 left a comment

Rok93 Feb 3, 2025

wishoon Feb 8, 2025

Rok93 Feb 3, 2025

Rok93 Feb 3, 2025

Rok93 Feb 3, 2025

wishoon Feb 8, 2025

Rok93 Feb 3, 2025

wishoon Feb 8, 2025

Rok93 Feb 3, 2025

wishoon Feb 8, 2025

Rok93 Feb 9, 2025

Rok93 Feb 3, 2025

wishoon Feb 8, 2025

Rok93 Feb 3, 2025

Rok93 Feb 3, 2025

wishoon Feb 8, 2025

Rok93 Feb 3, 2025

wishoon Feb 8, 2025

wishoon left a comment

wishoon Feb 8, 2025

wishoon Feb 8, 2025

wishoon Feb 8, 2025

wishoon Feb 8, 2025

wishoon Feb 8, 2025

wishoon Feb 8, 2025

wishoon Feb 8, 2025

Rok93 left a comment

Rok93 Feb 9, 2025

Rok93 Feb 9, 2025

Rok93 Feb 9, 2025

Rok93 Feb 9, 2025

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


		### 메뉴 그룹

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


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

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


		### 주문

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

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

		- [ ] 주문의 '주문 유형'이 배달이면서 주문의 '주문 상태'가 배달 완료가 아닌 경우, 주문의 '주문 상태'를 주문 완료로 수정할 수 있다.
		- [ ] 주문의 '주문 유형'이 포장 또는 매장식사 이면서 주문의 '주문 상태'가 서빙 완료가 아닌 경우, 주문의 '주문 상태'를 주문 완료로 수정할 수 없다.

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

Are you sure you want to change the base?

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

Conversation

wishoon commented Feb 2, 2025

Rok93 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wishoon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Rok93 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment