From 52a47d59d1cf303c83252c3f28fd99aa22965267 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EC=9D=B4=EC=84=9C=EC=A4=80?= <104981505+xeoxxn@users.noreply.github.com> Date: Wed, 9 Sep 2026 16:59:13 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20=EC=9A=A9=EC=96=B4=20=EC=82=AC=EC=A0=84?= =?UTF-8?q?=20=EC=BB=A8=EB=B2=A4=EC=85=98=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/conventions/coding-style.md | 1 + docs/conventions/terminology.md | 38 ++++++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 100644 docs/conventions/terminology.md diff --git a/docs/conventions/coding-style.md b/docs/conventions/coding-style.md index 32a4b6f..3b04a4d 100644 --- a/docs/conventions/coding-style.md +++ b/docs/conventions/coding-style.md @@ -16,6 +16,7 @@ - 훅: `useXxx`. 일반 함수/변수: camelCase. 상수: `UPPER_SNAKE_CASE`. - 불리언: `is` / `has` / `should` 접두사. - 폴더: 도메인명 소문자 또는 kebab-case. +- **도메인 이름은 임의로 번역/축약하지 않는다.** `features/<기능>/` 폴더명, 라우트 경로, 도메인 접두사가 붙는 컴포넌트/타입명은 `docs/conventions/terminology.md`(용어 사전)의 코드 용어를 그대로 쓴다 — 백엔드 API 엔드포인트 네이밍과 맞추기 위함이다. 사전에 없는 새 도메인이면 먼저 그 문서에 추가한 뒤 코드에 반영한다. ## 폴더 구조 diff --git a/docs/conventions/terminology.md b/docs/conventions/terminology.md new file mode 100644 index 0000000..3c1f89a --- /dev/null +++ b/docs/conventions/terminology.md @@ -0,0 +1,38 @@ +# 용어 사전 (한글 도메인명 ↔ 코드 용어) + +> 코드에서 도메인 이름을 임의로 짓지 않기 위한 사전. 백엔드 API 엔드포인트 네이밍과 프론트 코드(라우트 경로, `src/features/` 폴더명, 컴포넌트/타입 접두사 등)가 같은 용어를 쓰게 맞춘다. + +## 원칙 + +- 새 기능/화면을 만들 때 도메인 이름이 필요하면, 영어로 대충 번역하지 말고 **반드시 이 표부터 확인한다.** +- 여기 없는 새 도메인이 생기면 백엔드와 협의해서 엔드포인트 네이밍을 먼저 정하고, 그걸 이 표에 추가한 뒤 코드에 반영한다 — 프론트에서 먼저 임의로 정하지 않는다. +- 표의 "코드 용어"는 백엔드 엔드포인트 세그먼트(`/api/{코드 용어}/...`)와 동일한 문자열이다. 프론트에서는 아래 "적용 범위"에 그대로 쓴다. + +## 사전 + +| 한글 도메인명 | 코드 용어 | +| --- | --- | +| 공통 | `auth` | +| 사용자 | `users` | +| 게시판(공지) | `notices` | +| 게시판(열린피드백) | `feedbacks` | +| 빌릴게 | `bililge` | +| 사물함 | `lockers` | +| 슬랑제 | `seulrangjes` | +| 아카이빙 | `archives` | +| 챗봇 | `chat` | +| 파일 | `files` | +| 행사(event) | `events` | +| 회비 납부 | `fee` | + +## 적용 범위 + +- 백엔드 API 엔드포인트 경로: `/api/{코드 용어}/...` +- 프론트 라우트 경로: `/{코드 용어}` +- `src/features/{코드 용어}/` 폴더명 +- 그 안의 컴포넌트/타입/상수 이름의 도메인 접두사 — 코드 용어를 PascalCase로 바꿔서 쓴다 (예: `bililge` → `Bililge...`, `bililgeItems` 같은 camelCase 변수명도 동일) +- Figma 노드/화면 이름은 그대로 한글을 쓴다(디자이너와의 소통 채널이라 번역하지 않음) — 코드 파일 최상단의 `// Figma: ...` 주석에서만 한글 화면명을 남긴다. + +## 반영 사례 + +- "빌릴게" 기능: 처음엔 `rental`로 임의 명명했다가, 이 사전을 도입하면서 `src/features/rental/` → `src/features/bililge/`로 전체 리네이밍했다(#18).