-
Notifications
You must be signed in to change notification settings - Fork 216
docs: understanding knowledge, naming page translated into Korean #762
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
a321630
docs: understanding knowlege-types, naming page translated into Korean
Gaic4o 10ac538
docs: lnowledge-types, naming page feedback
Gaic4o 85ec8ef
Merge branch 'master' into under
Gaic4o 1dfa65d
fix: knownledge-types page text link add
Gaic4o File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
65 changes: 65 additions & 0 deletions
65
i18n/kr/docusaurus-plugin-content-docs/current/about/understanding/naming.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| --- | ||
| sidebar_position: 4 | ||
| --- | ||
|
|
||
| # 네이밍 (Naming) | ||
|
|
||
| 개발자들은 같은 대상을 각자의 경험과 관점에 따라 다르게 부르곤 합니다. 예를 들어: | ||
|
|
||
| - UI 컴포넌트를 "ui", "components", "ui-kit", "views" 등으로 표현 | ||
| - 공통 코드를 "core", "shared", "app" 등으로 지칭 | ||
| - 비즈니스 로직을 "store", "model", "state" 등으로 명명 | ||
|
|
||
| ## Feature-Sliced Design의 표준 네이밍 {#naming-in-fsd} | ||
|
|
||
| FSD는 다음과 같이 명확한 네이밍 규칙을 제시합니다: | ||
|
|
||
| ### Layers (계층) | ||
| - `app` | ||
| - `processes` | ||
| - `pages` | ||
| - `features` | ||
| - `entities` | ||
| - `shared` | ||
|
|
||
| ### Segments (세그먼트) | ||
| - `ui` | ||
| - `model` | ||
| - `lib` | ||
| - `api` | ||
| - `config` | ||
|
|
||
| 이러한 표준 용어를 사용하면: | ||
| - 팀 내 의사소통이 명확해집니다 | ||
| - 새로운 팀원의 적응이 쉬워집니다 | ||
| - 커뮤니티와의 지식 공유가 용이해집니다 | ||
|
|
||
| ## 네이밍 충돌 해결 {#when-can-naming-interfere} | ||
|
|
||
| FSD 용어가 프로젝트의 비즈니스 용어와 중복될 수 있습니다. 예시: | ||
|
|
||
| - `FSD#process` vs 애플리케이션의 시뮬레이션 프로세스, | ||
| - `FSD#page` vs 로그 페이지, | ||
| - `FSD#model` vs 자동차 모델. | ||
|
|
||
| ### 용어 사용 가이드 | ||
|
|
||
| 1. 기술적 커뮤니케이션 | ||
| - FSD 용어 사용 시 "FSD" 접두어 사용을 권장합니다 | ||
| - 예: "이 기능을 FSD features 계층으로 이동하는 것이 좋겠습니다" | ||
|
|
||
| 2. 비기술적 커뮤니케이션 | ||
| - FSD 관련 용어 사용을 피하고 일반적인 비즈니스 용어 사용 | ||
| - 예: 코드 구조 대신 기능이나 목적 중심으로 설명 | ||
|
|
||
| ## 참고 {#see-also} | ||
|
|
||
| - [(토론) Naming의 적응성][disc-src] | ||
| - [(토론) Entities Naming 설문조사][disc-naming] | ||
| - [(토론) "processes" vs "flows" vs ...][disc-processes] | ||
| - [(토론) "model" vs "store" vs ...][disc-model] | ||
|
|
||
| [disc-model]: https://github.com/feature-sliced/documentation/discussions/68 | ||
| [disc-naming]: https://github.com/feature-sliced/documentation/discussions/31#discussioncomment-464894 | ||
| [disc-processes]: https://github.com/feature-sliced/documentation/discussions/20 | ||
| [disc-src]: https://github.com/feature-sliced/documentation/discussions/16 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.