docs: Git 브랜치 및 커밋 메시지 작성 가이드 추가

This commit is contained in:
2025-07-14 17:09:01 +09:00
parent 79fe2476a2
commit 041771c6d6
15 changed files with 1124 additions and 0 deletions

View File

@ -0,0 +1,50 @@
# `doc-*`, `gui-*` (문서/가이드) Repository README 작성 가이드
`doc-*` (document) 또는 `gui-*` (guide) 접두사를 사용하는 저장소는 특정 주제에 대한 지식, 정책, 절차 등을 체계적으로 관리하는 것을 목적으로 합니다. README는 이 문서 저장소의 '목차'이자 '안내 데스크' 역할을 수행해야 합니다. 사용자가 원하는 정보를 쉽고 빠르게 찾을 수 있도록 돕는 것이 가장 중요합니다.
---
### 1. 문서 개요 (Documentation Overview)
- **문서의 목적 (Purpose)**: 이 문서 저장소가 어떤 종류의 정보(예: 온보딩 가이드, 개발 표준, 아키텍처 결정 기록)를 다루는지 명확히 설명합니다.
- **대상 독자 (Target Audience)**: 이 문서를 주로 읽게 될 사람이 누구인지(예: 신규 입사자, 프론트엔드 개발자, 모든 엔지니어) 명시하여 내용의 깊이와 범위를 짐작할 수 있게 합니다.
### 2. 목차 또는 주요 문서 링크 (Table of Contents or Key Links)
- **가장 중요한 섹션**: 사용자가 원하는 정보로 바로 이동할 수 있도록, 잘 정리된 목차나 핵심 문서로의 링크 목록을 제공해야 합니다.
- **구성 방법**:
- **주제별 분류**: 관련된 문서들을 카테고리별로 묶어 제공합니다.
- **🚀 시작하기**
- [개발 환경 설정 가이드](./getting-started/setup-dev-env.md)
- [첫 번째 Pull Request 만들기](./getting-started/first-pr.md)
- **🎨 프론트엔드 가이드**
- [코딩 컨벤션](./frontend/coding-style.md)
- [상태 관리 전략](./frontend/state-management.md)
- **⚙️ 백엔드 가이드**
- [API 설계 원칙](./backend/api-design.md)
- [데이터베이스 마이그레이션 절차](./backend/db-migration.md)
- **상대 경로 사용**: 저장소 내 다른 문서로 연결할 때는 반드시 상대 경로(`.` 또는 `..`로 시작)를 사용하여 링크가 깨지지 않도록 합니다.
### 3. 문서 구조 (Repository Structure)
- **목적**: 문서가 어떤 기준으로 폴더에 정리되어 있는지 설명하여, 사용자가 원하는 정보가 어디에 있을지 예측할 수 있도록 돕습니다.
- **예시**:
```plaintext
/
├── getting-started/ # 신규 입사자 및 초기 설정
├── frontend/ # 프론트엔드 관련 규칙 및 가이드
├── backend/ # 백엔드 관련 규칙 및 가이드
├── adr/ # 아키텍처 결정 기록 (Architecture Decision Records)
└── assets/ # 문서에 사용되는 이미지 파일
```
### 4. 문서 업데이트 및 기여 방법 (Contributing to the Docs)
- **목적**: 문서의 내용을 최신으로 유지하기 위해, 누구나 쉽게 내용을 추가하거나 수정할 수 있는 방법을 안내합니다.
- **프로세스**:
- **수정 제안**: 오타 수정이나 내용 보강은 어떻게 제안하는지 설명합니다. (예: "Pull Request를 생성해주세요.")
- **새로운 문서 추가**: 새로운 가이드를 작성할 때 따라야 할 템플릿이나 절차를 안내합니다.
- **리뷰 프로세스**: 문서 변경 사항은 누가, 어떻게 리뷰하는지 설명합니다. (예: "프론트엔드 챕터 리더의 승인이 필요합니다.")
### 5. 검색 팁 (Search Tips)
- **목적**: 사용자가 GitHub의 내장 검색 기능을 효과적으로 활용하여 정보를 찾을 수 있도록 팁을 제공합니다.
- **예시**: "GitHub 검색창에 `repo:my-org/my-docs state management` 와 같이 검색하면 이 저장소 내에서 'state management'에 대한 내용을 쉽게 찾을 수 있습니다."
### 6. 목차 자동 생성 (Optional: Automated TOC)
- **도구 안내**: `markdown-toc` 같은 도구를 사용하여 목차를 자동으로 생성하고 업데이트하는 방법을 안내할 수 있습니다. 이는 문서 구조가 자주 변경될 때 유용합니다.