🚀 2단계 - 요구 사항 정리 #774

hae-gun · 2025-01-26T12:46:25Z

요구사항 정리사항입니다.

작성하면서 궁금했던 점은 현재 요구사항을 서비스 클래스를 기준으로 작성하였습니다.

실제로는 요구사항을 코드로 구현하는 방법으로 진행될텐데 반대로 진행되니 꽤나 신선한? 방식이었지만 어려움도 조금 있었습니다.

따끔한 피드백을 주시면 감사하겠습니다.

1. separator 책임분리 2. 일급컬랙션 반환값 변경 (Integer -> StringNumber) 3. 덧샘로직 스트림활용

MaroKim

최혜근님 요구사항 너무 잘 작성해주셨습니다. 👍

내용만 살짝 다듬어 주시면 될것 같아서 관련 코멘트를 드렸습니다.
확인 부탁드립니다.

MaroKim · 2025-01-26T13:16:22Z

src/main/java/stringcalcurator/Separator.java

+public class Separator {
+    private static final String DEFAULT_SPLIT_REGEX = "[,:]";
+    private static final String CUSTOM_SPLIT_REGEX = "//(.)\n(.*)";
+


리뷰 반영 감사합니다 :)
답변 주신것도 다음에는 좀더 꼼꼼하게 확인하겠습니다.

MaroKim · 2025-01-26T13:18:08Z

src/main/java/stringcalcurator/Separator.java

+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+public class Separator {


분리하는 클래스 자제를 생성해주셨네요 👍
꼭 덧셈계산기가 아니어도 사용할수 있을것 같아요

MaroKim · 2025-01-26T13:19:22Z

src/main/java/stringcalcurator/StringNumberList.java

+    public List<StringNumber> getIntNumbers(){
+        return numbers;
    }


내부 데이터 은닉화 👍

MaroKim · 2025-01-26T13:55:25Z

README.md

+    - [ ] 각 메뉴는 1개의 메뉴 그룹을 필수로 갖는다.
+    - [ ] 각 메뉴는 1개 이상의 메뉴 상품을 필수로 가져야 하며, 해당 메뉴 상품들은 모두 등록된 상품이어야 한다.
+    - [ ] 각 메뉴는 유니크한 ID를 갖는다. (UUID)
+    - [ ] 가격(price) 는 null 이 될수 없으며, 0 이상의 양수값 이어야 한다.


조건 자체는 올바르게 작성해주셨습니다.
다만, 요구사항의 경우 개발자만 보는것이 아니라 해당 프로젝트를 진행하는 모든 이해관계자가 보는 문서 이므로
null이라는 기술적인 표현은 지양하고 모두가 이해할 수 있는 문장으로 작성해주시면 좋을 것 같아요 :)

MaroKim · 2025-01-26T14:03:02Z

README.md

+  - [ ] 주문은 총 3가지의 타입이 존재한다. (DELIVERY, TAKEOUT, EAT_IN)
+  - [ ] 주문은 총 6가지의 상태가 존재한다. (WAITING, ACCEPTED, SERVED, DELIVERING, DELIVERED, COMPLETED)


주문의 타입과 상태를 잘 분류 해주셨어요 👍
다만 아래에서는 한글과 같이 표기 해주셨는데 여기서도 동일하게 한글로 같이 표기해주시면 좋을것 같습니다.

MaroKim · 2025-01-27T08:45:48Z

README.md


+- 주문 (Order) : 사용자가 주문한 상품 목록
+  - [ ] 주문은 총 3가지의 타입이 존재한다. (DELIVERY, TAKEOUT, EAT_IN)


주문 타입별로 주문이 처리되는 과정의 차이가 있습니다.
해당 내용도 작성해주시면 좋을것 같아요 :)

네 해당 내용들이 아래에 기재되어 있긴 한데, 가독성에 있어서 하위 항목으로 있어야 하는것이 요구사항 파악에 더 확실하게 느껴지는 것 같네요. 고친 docs 내용에서 기존에 아래에 있던 내용들을 해당 목록의 하위 목록으로 이동시켜보았습니다.

MaroKim · 2025-01-27T08:48:29Z

README.md

+  - [ ] 각 메뉴 그룹은 유니크한 ID를 갖는다. (UUID)
+  - [ ] 이름은 null 이 될수 없다.
+
+- 상품(Product) : 판매되는 상품


상품은 조회도 가능한걸로 보이는데 해당 내용도 작성해주시면 좋을것 같아요

MaroKim · 2025-01-27T08:52:54Z

README.md

+  - [ ] 메뉴 가격 변경이 가능하다.
+    - [ ] 변경되는 가격은 0 이상의 양수값 이어야 한다. 
+    - [ ] 가격은 변경이 가능하나, 포함한 메뉴 상품의 가격의 합보다 클수 없다.
+  - [ ] 메뉴의 활성화 여부 변경이 가능하다.


활성화/비활성화 라는 표현을 좀더 쉽게 해주시면 좋을것 같아요 :)
사용자 입장에서 메뉴가 나타났다 사라졌다 하는걸 어떤 말로 써주시면 좋을까요?

MaroKim · 2025-01-27T08:57:06Z

README.md

+      - [ ] 주문의 상태가 배달중(DELIVERING) 이어야 한다.
+    - [ ] 주문은 '완료(COMPLETED)' 상태로 변경이 가능하다.
+      - [ ] 주문 타입이 배달(DELIVERY) 인 경우
+        - [ ] 주문 상태가 배달완료(DELIVERD) 가 아닌경우 변경이 불가능하다.


긍정문으로 표현이 가능한 부분은 긍정으로 해주시면 이해가 좀더 잘 될수 있습니다. :)
이 부분은 '주문 상태가 배달완료 이어야 한다' 라고 해주시면 어떨까요?

MaroKim · 2025-01-27T09:06:22Z

README.md

+  - [ ] 식사 테이블은 앉을수 있다.
+    - [ ] 테이블 사용중 상태를 true 로 지정한다.
+  - [ ] 식사 테이블은 초기화 할수 있다.
+    - [ ] 테이블의 주문의 상태가 완료(COMPLETED) 라면 초기화 할수 없다.
+    - [ ] 테이블 손님수(numberOfGuests)를 0 으로 지정한다.
+    - [ ] 테이블 사용중(occupied)의 상태를 false로 지정한다.
+  - [ ] 식사 테이블을 사용중인 손님의 수를 변경할 수 있다.
+    - [ ] 변경되는 손님수는 0이상의 숫자이어야 한다.
+    - [ ] 사용중인 테이블이 아니면 손님수를 변경할 수 없다.


위에 제가 리뷰드린 내용처럼 테이블의 상태값을 정의 해주신다면 좀더 다듬어 주실수 있을 것 같아요 :)

'식사 테이블은 앉을수 있다'는 테이블의 상태가 바뀌는 행위입니다.
각각 상태가 어떤것으로 바뀌고 그에 대한 설명을 작성해주시는걸로 해보시는게 어떨까요?

MaroKim

혜근님 빠르게 반영 해주셨네요 👍

몇가지 코멘트를 드렸는데 간단한 내용이라
다음 미션하시기 전에 정리가 가능하실것 같아서 머지하겠습니다.

고생하셨습니다 😄

MaroKim · 2025-01-27T12:51:20Z

README.md

+- 주문 (Order) : 사용자가 주문한 상품 목록
+  - [ ] 주문은 총 6가지의 상태가 존재한다. 
+    - 준비(WAITTING), 수락(ACCEPTED), 서빙됨(SERVED), 배달중(DELIVERING), 배달완료(DELIVERD), 완료(COMPLETED)
+  - [ ] 주문은 생성이 가능하다.
+    - [ ] 주문은 총 3가지의 타입이 존재한다. ( 배달(DELIVERY), 포장(TAKEOUT), 매장식사(EAT_IN)) 


리뷰에 답변해주신것을 확인했는데 제가 설명이 부족했던 것 같습니다 🙇‍♂️
각 타입별로 프로세스 흐름을 설명을 초기에 간단하게 소개 하면 좋겠다는 생각에 말씀드렸습니다
(예시 : 주문 타입이 포장인 경우 주문 상태는 (준비 -> 수락 -> 서빙됨 ->완료 ) 순서로 변경된다.)

MaroKim · 2025-01-27T12:52:49Z

README.md

+    - [ ] 가격(price) 은 필수로 입력되어야 하며, 0 이상의 양수값 이어야 한다.
+    - [ ] 메뉴의 이름(name)은 필수로 입력되어야 하며, 비속어가 포함될 수 없다.


이제 모든 이해관계자가 충분히 이해할 수 있을것 같습니다 👍

MaroKim · 2025-01-27T13:03:54Z

README.md

+  - [ ] 메뉴 가격 변경이 가능하다.
+    - [ ] 변경되는 가격은 0 이상의 양수값 이어야 한다. 
+    - [ ] 가격은 변경이 가능하나, 포함한 메뉴 상품의 가격의 합보다 클수 없다.
+  - [ ] 메뉴 화면 표시 여부 변경이 가능하다.


화면 표시로 변경해주셨네요 😄
표시하다, 숨기다, 표시하시 않다 등의 비슷한 단어를 선택해서 표현할 수 있을것 같아요

MaroKim · 2025-01-27T13:04:34Z

README.md

+        - [ ] 배송지 주소는 필수값이다.
+        - [ ] 위 조건 만족시, 배송지를 설정한다.
+    - [ ] 주문 내역은 필수이다. 해당 주문 내역들은 메뉴에 포함되어있는 항목이어야 한다.
+    - [ ] 주문 내역 중 활성화 되지 않은 메뉴는 포함될수 없다.


표시 여부로 변경해주신거에 맞춰서 여기도 변경해주시면 좋을것 같아요 :)

MaroKim · 2025-01-27T13:08:42Z

README.md

+    - [ ] 주문은 '배달중(DELIVERING)' 상태로 변경이 가능하다.
+      - [ ] 주문의 타입이 배달(DELIVERY) 이어야 한다.
+      - [ ] 주문의 상태가 서빙됨(SERVED) 이어야 한다.
+    - [ ] 주문은 '배달완료(DELIVERD)' 상태로 변경이 가능하다.
+      - [ ] 주문의 상태가 배달중(DELIVERING) 이어야 한다.
+    - [ ] 주문은 '완료(COMPLETED)' 상태로 변경이 가능하다.
+      - [ ] 주문 타입이 배달(DELIVERY) 인 경우
+        - [ ] 주문 상태가 배달완료(DELIVERD) 인 경우에 변경이 가능하다.
+      - [ ] 주문 타입이 포장(TAKEOUT) 인 경우
+        - [ ] 주문의 상태가 서빙됨(SERVED) 인 경우에 변경이 가능하다.
+      - [ ] 주문 타입이 매장식사(EAT_IN) 인 경우
+        - [ ] 주문의 상태가 서빙됨(SERVED) 인 경우에 변경이 가능하다.
+        - [ ] 해당 식사 테이블의 상태를 초기화 한다.


긍정문으로 바꿔 주셨네요 😃
반영 감사합니다

MaroKim · 2025-01-27T13:09:41Z

README.md

+    - [ ] 테이블 사용여부(occupied)의 상태를 미사용(false)으로 지정한다.
+  - [ ] 식사 테이블의 사용여부(occupied) 의 상태를 사용중(true) 로 변경할 수 있다.


단어를 사용중, 미사용으로 채택해주셨네요 👍

MaroKim · 2025-01-27T13:11:58Z

README.md

+    - [ ] 상품의 이름은 필수로 입력되어야 하며, 비속어가 포함될 수 없다.
+  - [ ] 상품의 가격은 변동 가능하다.
+    - [ ] 변경되는 가격은 필수로 입력되어야 하며, 0 이상의 양수값만 가능하다.
+    - [ ] 변경후 메뉴의 가격 보다 메뉴 상품 총 가격값이 크다면 해당 메뉴를 비활성화 한다.


요기도 표시여부에 맞춰서 단어를 변경해주시면 좋을 것 같아요 :)

MaroKim · 2025-01-27T13:28:15Z

README.md

+    - [ ] 테이블 손님수(numberOfGuests)를 0 으로 지정한다.
+    - [ ] 테이블 사용여부(occupied)의 상태를 미사용(false)으로 지정한다.
+  - [ ] 식사 테이블의 사용여부(occupied) 의 상태를 사용중(true) 로 변경할 수 있다.
+  - [ ] 식사 테이블은 초기화 할수 있다.


식사테이블의 사용여부 상태값에 대한 단어를 사용중, 미사용으로 변경해주셨는데

초기화 라는 단어도 변경이 가능할 것 같아요 :)

MaroKim · 2025-01-27T13:34:19Z

README.md

+    - [ ] 테이블 사용여부(occupied)의 상태를 미사용(false)으로 지정한다.
+  - [ ] 식사 테이블의 사용여부(occupied) 의 상태를 사용중(true) 로 변경할 수 있다.
+  - [ ] 식사 테이블은 초기화 할수 있다.
+    - [ ] 테이블의 주문의 상태가 완료(COMPLETED) 라면 초기화 할수 없다.


이 부분은 한번 다시 확인 부탁드리겠습니다 :)

hae-gun added 5 commits January 25, 2025 14:11

refactor(stringnumber): 리뷰반영

b2a6832

1. separator 책임분리 2. 일급컬랙션 반환값 변경 (Integer -> StringNumber) 3. 덧샘로직 스트림활용

refactor(stringnumber): separator 완전 분리

aabd9f4

refactor(stringnumber): 메서드명 변경

ba3c918

docs: 요구사항 정리

7bb3859

docs: 요구사항 정리

75fa61f

MaroKim requested changes Jan 27, 2025

View reviewed changes

hae-gun added 4 commits January 27, 2025 20:33

docs: 피드백 적용

df7739f

docs: 피드백 적용 (긍정문 표현 변경)

82a1e98

docs: 피드백 적용 (긍정문 표현 변경)

56f5f2c

docs: 피드백 적용 (문맥 변경)

aaf2ebe

MaroKim approved these changes Jan 27, 2025

View reviewed changes

MaroKim merged commit 51d6c72 into next-step:hae-gun Jan 27, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🚀 2단계 - 요구 사항 정리 #774

🚀 2단계 - 요구 사항 정리 #774

hae-gun commented Jan 26, 2025

MaroKim left a comment

MaroKim Jan 26, 2025

MaroKim Jan 26, 2025

MaroKim Jan 26, 2025

MaroKim Jan 26, 2025

MaroKim Jan 26, 2025

MaroKim Jan 27, 2025

hae-gun Jan 27, 2025

MaroKim Jan 27, 2025

MaroKim Jan 27, 2025

MaroKim Jan 27, 2025

MaroKim Jan 27, 2025

MaroKim left a comment

MaroKim Jan 27, 2025

MaroKim Jan 27, 2025

MaroKim Jan 27, 2025

MaroKim Jan 27, 2025

MaroKim Jan 27, 2025

MaroKim Jan 27, 2025

MaroKim Jan 27, 2025

MaroKim Jan 27, 2025

MaroKim Jan 27, 2025

		- [ ] 주문은 총 3가지의 타입이 존재한다. (DELIVERY, TAKEOUT, EAT_IN)
		- [ ] 주문은 총 6가지의 상태가 존재한다. (WAITING, ACCEPTED, SERVED, DELIVERING, DELIVERED, COMPLETED)


		- 주문 (Order) : 사용자가 주문한 상품 목록
		- [ ] 주문은 총 3가지의 타입이 존재한다. (DELIVERY, TAKEOUT, EAT_IN)

		- [ ] 가격(price) 은 필수로 입력되어야 하며, 0 이상의 양수값 이어야 한다.
		- [ ] 메뉴의 이름(name)은 필수로 입력되어야 하며, 비속어가 포함될 수 없다.

		- [ ] 테이블 사용여부(occupied)의 상태를 미사용(false)으로 지정한다.
		- [ ] 식사 테이블의 사용여부(occupied) 의 상태를 사용중(true) 로 변경할 수 있다.

🚀 2단계 - 요구 사항 정리 #774

🚀 2단계 - 요구 사항 정리 #774

Conversation

hae-gun commented Jan 26, 2025

MaroKim 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

MaroKim 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