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๋‹จ๊ณ„ - ๋ชจ๋ธ๋ง ํ•˜๊ธฐ #401

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

Conversation

kimjunbo
Copy link

๋™์ฒ ๋‹˜ ์•ˆ๋…•ํ•˜์„ธ์š”~

2๋‹จ๊ณ„ ๋ฏธ์…˜ PR ๋“œ๋ฆฝ๋‹ˆ๋‹ค.

์ž˜ ๋ถ€ํƒ๋“œ๋ฆฝ๋‹ˆ๋‹ค!

@kimjunbo kimjunbo changed the title doc: add modeling, diagram, policies, context map ๐Ÿš€ 2๋‹จ๊ณ„ - ๋ชจ๋ธ๋ง ํ•˜๊ธฐ May 24, 2024
Copy link

@sah3122 sah3122 left a comment

Choose a reason for hiding this comment

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

๋ชจ๋ธ๋ง ๋ฌธ์„œ ์ž‘์„ฑ ์ž˜ํ•ด์ฃผ์…จ๋„ค์š” ๐Ÿ‘
๋ช‡๊ฐ€์ง€ ์ƒ๊ฐ๊ฑฐ๋ฆฌ๋ฅผ ๋‚จ๊ฒจ๋‘์—ˆ๋Š”๋ฐ ํ™•์ธ ๋ถ€ํƒ๋“œ๋ฆฝ๋‹ˆ๋‹ค ๐Ÿ˜„

4. (์‚ฌ์žฅ๋‹˜) ๋ฉ”๋‰ด๋ฅผ ๋“ฑ๋กํ•œ๋‹ค.

## CONTEXT MAP
![img.png](images/context-map.png)
Copy link

Choose a reason for hiding this comment

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

์ปจํ…์ŠคํŠธ ๋งต๊นŒ์ง€ ์ถ”๊ฐ€ ํ•ด์ฃผ์…จ๋„ค์š” ๐Ÿ‘

@@ -271,3 +271,239 @@ docker compose -p kitchenpos up -d
| ์น˜์šด๋‹ค. | clear | ์ฃผ๋ฌธ ํ…Œ์ด๋ธ”์„ ์น˜์šด๋‹ค. |

## ๋ชจ๋ธ๋ง

### ์ƒํ’ˆ(Product)
#### ์ƒํƒœ
Copy link

Choose a reason for hiding this comment

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

์ƒํƒœ์™€ ํ–‰์œ„๋ฅผ ๋ถ„๋ฆฌํ•˜์—ฌ ๋ชจ๋ธ๋ง์„ ์ง„ํ–‰ํ•ด์ฃผ์…จ๋„ค์š” ๐Ÿ‘
๋‘ ๊ฒฝ๊ณ„๊ฐ€ ๋ช…ํ™•ํ•˜๊ฒŒ ๋‚˜๋ˆ„์–ด์ง„๊ฒƒ์€ ์žฅ์ ์ด์ง€๋งŒ, ์ž‘์„ฑํ•ด์ฃผ์‹  ํ–‰์œ„๋ฅผ๋ณด๋ฉด ์ƒํƒœ์— ๊ด€๋ จ๋œ ๋‚ด์šฉ๋“ค์ด ํ–‰์œ„์—์„œ๋Š” ์ƒ๋žต๋œ๊ฒƒ ๊ฐ™์•„์š”.
๋ชจ๋ธ๋ง ๋ฌธ์„œ๋ฅผ ๋ณด๋Š” ์ž…์žฅ์—์„œ ์ƒํƒœ์— ๋Œ€ํ•œ ์ง€์‹์ด ์—†๋‹ค๋ฉด ํ–‰์œ„๋งŒ ๋ด์„œ๋Š” ์–ด๋–ค ์š”๊ตฌ์‚ฌํ•ญ์„ ๋ชจ๋ธ๋งํ•œ๊ฒƒ์ธ์ง€ ํ—ท๊ฐˆ๋ฆด์ˆ˜ ์žˆ๋‹ค๋Š” ์ƒ๊ฐ์ด ๋“ญ๋‹ˆ๋‹ค.
ํ–‰์œ„์—์„œ๋„ ์ƒํƒœ์— ๊ด€๋ จํ•œ ๋‚ด์šฉ์„ ๋ชจ๋‘ ์ƒ๋žตํ•˜์ง€ ์•Š๊ณ  ์ ์ ˆํ•˜๊ฒŒ ํ‘œ๊ธฐํ•ด๋ณด๋Š”๊ฑด ์–ด๋–จ๊นŒ์š” ?

- ๊ฐ€๊ฒฉ์€ 0์›๋ณด๋‹ค ์ž‘์„ ์ˆ˜ ์—†๋‹ค.
#### ํ–‰์œ„
- ์ƒํ’ˆ์„ ๋“ฑ๋กํ•  ์ˆ˜ ์žˆ๋‹ค.
- PurgomalumClient๋ฅผ ํ†ตํ•ด ๋น„์†์–ด ๊ฒ€์ฆ์„ ํ•œ๋‹ค.
Copy link

Choose a reason for hiding this comment

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

์•ž์„  ์ฝ”๋ฉ˜ํŠธ์—์„œ ๋ถ€์—ฐ ์„ค๋ช…ํ•˜์ž๋ฉด ์–ด๋–ค๊ฒƒ์„ ๋น„์†์–ด ๊ฒ€์ฆ์„ ํ•˜๋Š”์ง€ ์•Œ์ˆ˜๊ฐ€ ์—†์Šต๋‹ˆ๋‹ค.
ํŠนํžˆ, ๋„๋ฉ”์ธ์— ์ต์ˆ™ํ•˜์ง€ ์•Š์€ ์‚ฌ๋žŒ์ด๋ผ๋ฉด ๋”์šฑ ์•Œ๊ธฐ ์–ด๋ ค์šธ๊ฒƒ ๊ฐ™์•„์š” ๐Ÿ˜„

- ๋ฐฐ๋‹ฌํ•˜๊ธฐ ์ฃผ๋ฌธ์ธ ๊ฒฝ์šฐ์—๋Š” ๋น„์–ด์žˆ์„ ์ˆ˜ ์—†๋‹ค.
- ์ฃผ๋ฌธ ํ…Œ์ด๋ธ”(orderTable)
- ๋จน๊ณ ๊ฐ€๊ธฐ์ธ ๊ฒฝ์šฐ ์ฃผ๋ฌธ ํ…Œ์ด๋ธ”์€ ํ•„์ˆ˜๊ฐ’์ด๋‹ค.
#### ํ–‰์œ„
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.

์œ„์—์„œ mermaid๋ฅผ ํ™œ์šฉํ•˜์—ฌ ํด๋ž˜์Šค ๋‹ค์ด์–ด๊ทธ๋žจ์„ ์ž‘์„ฑํ•ด์ฃผ์…จ๋Š”๋ฐ, ๋‚˜์•„๊ฐ€ ํ•ด๋‹น ์ •์ฑ…๋“ค์„ sequence diagram์œผ๋กœ ํ‘œํ˜„ํ•ด๋ณด๋Š”๊ฑด ์–ด๋–จ๊นŒ์š” ?
https://mermaid.js.org/syntax/sequenceDiagram.html

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