From bdad87e092c9f7fba8e56cc324dc44c14a5f732a Mon Sep 17 00:00:00 2001 From: happybell80 Date: Wed, 21 Jan 2026 14:09:52 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20=EC=BD=94=EB=93=9C/=EB=AC=B8=EC=84=9C?= =?UTF-8?q?=20=ED=81=AC=EA=B8=B0=20=EC=A0=9C=ED=95=9C=20=EC=99=84=ED=99=94?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 백엔드/프론트 파일 크기: 300줄 → 500줄 - 트러블슈팅 문서: 100줄 → 150줄 - 계획 문서: 150줄 → 200줄 - 인덱스 README: 100줄 → 150줄 - 리서치/아키텍처 문서: 200줄 → 250줄 --- book/300_architecture/311_백엔드_구조_원칙.md | 8 ++++---- book/300_architecture/312_문서_작성_원칙.md | 12 ++++++------ book/300_architecture/313_프론트_구조_원칙.md | 6 +++--- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/book/300_architecture/311_백엔드_구조_원칙.md b/book/300_architecture/311_백엔드_구조_원칙.md index 71312ac..b2cce10 100644 --- a/book/300_architecture/311_백엔드_구조_원칙.md +++ b/book/300_architecture/311_백엔드_구조_원칙.md @@ -1,7 +1,7 @@ # FastAPI 프로젝트 구조 원칙 **작성일**: 2025-09-17 -**수정일**: 2025-12-26 (LLM 프롬프트 실제 데이터 전달 원칙 추가) +**수정일**: 2026-01-21 (파일 크기 제한 300줄 → 500줄 완화) ## 1. 계층 분리 원칙 @@ -65,7 +65,7 @@ ### services/ - `{도메인}_{기능}.py`: coldmail_filter.py, ir_analyzer.py -- 한 파일 최대 300줄 +- 한 파일 최대 500줄 ### state/ (Repository 패턴) - `database.py`: 통합 DB 접근 @@ -186,7 +186,7 @@ utils ## 7. 파일 크기 제한 -- **한 파일 최대 300줄 권장** +- **한 파일 최대 500줄 권장** - 초과 시 기능별 분리 ## 8. Import 규칙 @@ -206,7 +206,7 @@ utils - [ ] DB 접근은 state를 통하는가? - [ ] 비즈니스 로직이 router에 있지 않은가? - [ ] 순환 import 가능성은 없는가? -- [ ] 핵심 파일은 300줄 이하로 유지할 수 있는가? +- [ ] 핵심 파일은 500줄 이하로 유지할 수 있는가? - [ ] 중복 코드는 utils/로 추출할 수 있는가? - [ ] DB 스키마 변경 시 ORM/DDL/Repository 동시 수정 확인 - [ ] Supabase 쿼리에서 컬럼명과 예약어 충돌 시 Python 로직으로 처리했는가? diff --git a/book/300_architecture/312_문서_작성_원칙.md b/book/300_architecture/312_문서_작성_원칙.md index c79cc89..863909a 100644 --- a/book/300_architecture/312_문서_작성_원칙.md +++ b/book/300_architecture/312_문서_작성_원칙.md @@ -1,7 +1,7 @@ # 문서 작성 원칙 **작성일**: 2025-10-13 -**수정일**: 2025-12-02 (CLAUDE.md → AGENTS.md 참조 변경), 2026-01-13 (troubleshooting 문서 남은 작업 기록 금지 규칙 추가) +**수정일**: 2026-01-21 (문서 크기 제한 완화: 트러블슈팅 100→150줄, 계획 150→200줄 등) **참고**: AGENTS.md, 311_백엔드_구조_원칙.md --- @@ -193,11 +193,11 @@ | 문서 유형 | 크기 제한 | 비고 | |----------|----------|------| -| 트러블슈팅 문서 | 100줄 이하 | 단일 이슈 중심, 초과 시 주제별 분리 | -| 계획 문서 | 150줄 이하 | Phase별로 분리 가능 | -| 인덱스 README.md | 100줄 이하 | 목차/인덱스 역할만 | -| 리서치 문서 | 200줄 이하 | 논문 요약 등 긴 내용 허용 | -| 아키텍처 문서 | 200줄 이하 | 섹션 많은 경우, 분리 가능하면 분리 우선 | +| 트러블슈팅 문서 | 150줄 이하 | 단일 이슈 중심, 초과 시 주제별 분리 | +| 계획 문서 | 200줄 이하 | Phase별로 분리 가능 | +| 인덱스 README.md | 150줄 이하 | 목차/인덱스 역할만 | +| 리서치 문서 | 250줄 이하 | 논문 요약 등 긴 내용 허용 | +| 아키텍처 문서 | 250줄 이하 | 섹션 많은 경우, 분리 가능하면 분리 우선 | ### 초과 시 처리 방법 diff --git a/book/300_architecture/313_프론트_구조_원칙.md b/book/300_architecture/313_프론트_구조_원칙.md index 69fc081..aa899b4 100644 --- a/book/300_architecture/313_프론트_구조_원칙.md +++ b/book/300_architecture/313_프론트_구조_원칙.md @@ -1,7 +1,7 @@ # React 프론트엔드 구조 원칙 **작성일**: 2025-11-29 -**수정일**: 2025-12-23 (라우팅 원칙, useCallback 무한루프 방지 원칙 추가) +**수정일**: 2026-01-21 (컴포넌트 분리 기준 300줄 → 500줄 완화) **참고**: 311_FastAPI_구조_원칙.md, 312_문서_작성_원칙.md ## 1. 컴포넌트 설계 원칙 @@ -12,7 +12,7 @@ - UI 렌더링과 비즈니스 로직 분리 ### 컴포넌트 분리 기준 -- 300줄 이상: 서브 컴포넌트 또는 커스텀 훅으로 분리 검토 +- 500줄 이상: 서브 컴포넌트 또는 커스텀 훅으로 분리 검토 - 1000줄 이상: Monolithic Component로 간주, 리팩토링 필수 - UI + API + State + Events 모두 혼재: 계층 분리 필요 @@ -178,7 +178,7 @@ src/ - [ ] 각 컴포넌트가 단일 책임을 수행하는가? - [ ] 비즈니스 로직이 커스텀 훅으로 분리되었는가? - [ ] 상태 변경이 Immutability 원칙을 따르는가? -- [ ] 파일 크기가 300줄 이하인가? (예외: 핵심 컴포넌트는 가급적 유지) +- [ ] 파일 크기가 500줄 이하인가? (예외: 핵심 컴포넌트는 가급적 유지) - [ ] 하드코딩된 값이 없는가? - [ ] Prop Drilling이 3단계 이상인가? (상태 관리 필요) - [ ] TypeScript 타입이 명확히 정의되었는가?