docs: rename backend coding principles ssot
This commit is contained in:
parent
ffb0bf3366
commit
c969cc5702
@ -1,4 +1,4 @@
|
||||
# FastAPI 프로젝트 구조 원칙
|
||||
# Backend Coding Principles
|
||||
|
||||
**작성일**: 2025-09-17
|
||||
**수정일**: 2026-01-21 (파일 크기 제한 300줄 → 500줄 완화)
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
**작성일**: 2025-10-13
|
||||
**수정일**: 2026-03-05 (SSOT 관리 기준 명시)
|
||||
**참고**: AGENTS.md, 311_백엔드_구조_원칙.md
|
||||
**참고**: AGENTS.md, 311_backend_coding_principles.md
|
||||
**상위 원칙**: [0_VALUE Writing Principles](../../../../0_VALUE/02_Governance/writing-principles.md)
|
||||
|
||||
---
|
||||
@ -47,7 +47,7 @@
|
||||
### 아키텍처 문서
|
||||
|
||||
**경로**: `DOCS/300_architecture/`
|
||||
**파일명**: `3NN_주제.md` (예: 311_백엔드_구조_원칙.md)
|
||||
**파일명**: `3NN_주제.md` (예: 311_backend_coding_principles.md)
|
||||
**규칙**:
|
||||
- 작성일/수정일 명시
|
||||
- 섹션 번호 사용
|
||||
@ -297,7 +297,7 @@
|
||||
### 필수 항목
|
||||
1. **원인**: 왜 문제가 발생했는가
|
||||
2. **교훈**: 다음에 어떻게 방지할 것인가
|
||||
3. **원칙**: 위반한 원칙이 있는가 (원칙 문서 참조: `311_백엔드_구조_원칙.md`, `312_writing-principles.md`)
|
||||
3. **원칙**: 위반한 원칙이 있는가 (원칙 문서 참조: `311_backend_coding_principles.md`, `312_writing-principles.md`)
|
||||
|
||||
### 올바른 예시
|
||||
```markdown
|
||||
@ -420,5 +420,5 @@ troubleshooting/ (실제 구현)
|
||||
## 9. 참고 문서
|
||||
|
||||
- AGENTS.md: 전체 개발 가이드
|
||||
- 311_백엔드_구조_원칙.md: 코드 구조 원칙
|
||||
- 311_backend_coding_principles.md: 코드 구조 원칙
|
||||
- troubleshooting/ 폴더: 트러블슈팅 예시
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
**작성일**: 2025-01-03
|
||||
**수정일**: 2026-02-04 (UX 검증 원칙 추가)
|
||||
**상위 원칙**: [0_VALUE Coding Principles](../../../../0_VALUE/02_Governance/coding-principles.md)
|
||||
**참고**: 311_백엔드_구조_원칙.md, 312_writing-principles.md
|
||||
**참고**: 311_backend_coding_principles.md, 312_writing-principles.md
|
||||
|
||||
---
|
||||
|
||||
@ -229,6 +229,6 @@ docker compose down && docker compose up -d --build
|
||||
|
||||
## 10. 참고
|
||||
|
||||
- FastAPI 구조 원칙: `311_백엔드_구조_원칙.md` 섹션 18 (테스트 원칙)
|
||||
- FastAPI 구조 원칙: `311_backend_coding_principles.md` 섹션 18 (테스트 원칙)
|
||||
- 문서 작성 원칙: `312_writing-principles.md` (troubleshooting 기록 방법)
|
||||
- 트러블슈팅: `journey/troubleshooting/251110_레거시_테스트_폴더_정리.md`
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
**상태**: 미구현 (실행 계획 보강)
|
||||
|
||||
**원칙 참조**:
|
||||
- `book/300_architecture/311_백엔드_구조_원칙.md` (계층 분리, DB state 경유)
|
||||
- `book/300_architecture/311_backend_coding_principles.md` (계층 분리, DB state 경유)
|
||||
- `book/300_architecture/312_writing-principles.md`
|
||||
- `book/300_architecture/315_테스트_원칙.md` (TDD)
|
||||
- `book/300_architecture/313_Gemini_프롬프트_설계_원칙.md`
|
||||
@ -530,7 +530,7 @@ post_check_result:
|
||||
---
|
||||
|
||||
## 참고 문서
|
||||
- `book/300_architecture/311_백엔드_구조_원칙.md`
|
||||
- `book/300_architecture/311_backend_coding_principles.md`
|
||||
- `book/300_architecture/312_writing-principles.md`
|
||||
- `book/300_architecture/315_테스트_원칙.md`
|
||||
- `book/300_architecture/313_Gemini_프롬프트_설계_원칙.md`
|
||||
|
||||
@ -10,7 +10,7 @@
|
||||
- 코드 기능 확장 전에 DB/로그 구조를 먼저 고정한다.
|
||||
- 기존 자산(`intent_review_queue`, `ir_deck_feedback`, `conversation_log`)을 재사용한다.
|
||||
- 부족한 영역(정책 버전/반성 기록)을 신규 테이블로 보완한다.
|
||||
- 구조/구현 원칙은 [311_백엔드_구조_원칙](../../book/300_architecture/311_백엔드_구조_원칙.md)을 단일 기준으로 따른다.
|
||||
- 구조/구현 원칙은 [311_backend_coding_principles](../../book/300_architecture/311_backend_coding_principles.md)을 단일 기준으로 따른다.
|
||||
|
||||
## 1-1) 로컬 개발자 실행 경계 (필수)
|
||||
|
||||
|
||||
@ -76,7 +76,7 @@
|
||||
|
||||
- `plans/archive/250808_감정시스템_현실적용_5단계_로드맵.md` (Phase 1–3 완료)
|
||||
- `plans/archive/260102_9월이전_미해결_항목_통합.md` (감정 시스템, 기술 부채)
|
||||
- `book/300_architecture/311_백엔드_구조_원칙.md`
|
||||
- `book/300_architecture/311_backend_coding_principles.md`
|
||||
- `book/300_architecture/315_테스트_원칙.md`
|
||||
- `troubleshooting/251204_admin_dashboard_business_integration.md` (완료)
|
||||
- `troubleshooting/251110_claude_gemini_file_search_coldmail_integration.md` (완료)
|
||||
|
||||
@ -39,7 +39,7 @@
|
||||
## 참고
|
||||
|
||||
- `book/200_core_design/225_온톨로지_기반_지식_표현.md`
|
||||
- `book/300_architecture/311_백엔드_구조_원칙.md`
|
||||
- `book/300_architecture/311_backend_coding_principles.md`
|
||||
- `book/300_architecture/312_writing-principles.md`
|
||||
- `book/300_architecture/315_테스트_원칙.md`
|
||||
- `troubleshooting/251002_emotion_top-p_improvement.md` (감정 직접 노출 금지)
|
||||
|
||||
@ -61,6 +61,6 @@ SKILL_PUBLISH_URL=http://localhost:8511
|
||||
- `troubleshooting/260127_news_history_api_implementation.md`
|
||||
|
||||
### 원칙 문서
|
||||
- `book/300_architecture/311_백엔드_구조_원칙.md` - 계층 분리, Repository 패턴, 테스트 원칙
|
||||
- `book/300_architecture/311_backend_coding_principles.md` - 계층 분리, Repository 패턴, 테스트 원칙
|
||||
- `book/300_architecture/312_writing-principles.md` - 문서 작성 규칙
|
||||
- `book/300_architecture/database/tables.md` - rb_news 테이블 스키마 참고
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
**상태**: Phase 1-1.5 완료, Phase 2-3 미구현
|
||||
|
||||
**원칙 참조** (구현 전 필수 확인):
|
||||
- `311_백엔드_구조_원칙.md`: 계층 분리, DB는 state 경유
|
||||
- `311_backend_coding_principles.md`: 계층 분리, DB는 state 경유
|
||||
- `312_writing-principles.md`: 핵심만 간결, 파일명:줄번호
|
||||
- `315_테스트_원칙.md`: 테스트는 TDD로 진행 (Red → Green → Refactor)
|
||||
|
||||
@ -124,7 +124,7 @@
|
||||
|
||||
## 참고
|
||||
|
||||
- `book/300_architecture/311_백엔드_구조_원칙.md`
|
||||
- `book/300_architecture/311_backend_coding_principles.md`
|
||||
- `book/300_architecture/315_테스트_원칙.md`
|
||||
- `troubleshooting/251014_claude_coldmail_filter_tokenization_issue.md`
|
||||
- `troubleshooting/251016_ontology_filter_validation.md`
|
||||
|
||||
@ -27,4 +27,4 @@
|
||||
|
||||
- `troubleshooting/251126_happybell80_rb8001_의도_3단계_아키텍처_도입_및_배포.md`
|
||||
- `troubleshooting/251126_intent_3step_db_bayesian_integration.md`
|
||||
- `book/300_architecture/311_백엔드_구조_원칙.md`
|
||||
- `book/300_architecture/311_backend_coding_principles.md`
|
||||
|
||||
@ -46,6 +46,6 @@
|
||||
- `troubleshooting/251126_intent_3step_db_bayesian_integration.md`
|
||||
- `troubleshooting/260203_intent_phase3_db_thompson_tests.md` (Phase 3 DB 접근·Thompson·테스트)
|
||||
- `plans/archive/251017_intent_analysis_improvement_plan.md` (251023으로 통합됨)
|
||||
- `book/300_architecture/311_백엔드_구조_원칙.md`
|
||||
- `book/300_architecture/311_backend_coding_principles.md`
|
||||
- `book/300_architecture/313_Gemini_프롬프트_설계_원칙.md`
|
||||
- `book/300_architecture/315_테스트_작성_원칙.md`
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
**작성자**: Claude
|
||||
**관련 파일**: `rb8001/app/services/skills/startup_news_skill.py`, `rb8001/app/services/workflows/headlines_workflow.py`, `rb8001/tests/test_headlines_workflow.py`
|
||||
**원칙 참조** (구현 전 필수 확인):
|
||||
- `311_백엔드_구조_원칙.md`: LangGraph 워크플로우 (섹션 5), 계층 분리
|
||||
- `311_backend_coding_principles.md`: LangGraph 워크플로우 (섹션 5), 계층 분리
|
||||
- `312_writing-principles.md`: 핵심만 간결, 파일명:줄번호
|
||||
- `315_테스트_원칙.md`: 테스트는 TDD로 진행 (Red → Green → Refactor)
|
||||
|
||||
@ -108,6 +108,6 @@ START → fetch_naver → fetch_sea → extract_terms → format → send → EN
|
||||
|
||||
## 참고
|
||||
|
||||
- `book/300_architecture/311_백엔드_구조_원칙.md`
|
||||
- `book/300_architecture/311_backend_coding_principles.md`
|
||||
- `book/300_architecture/312_writing-principles.md`
|
||||
- `book/300_architecture/315_테스트_원칙.md`
|
||||
|
||||
@ -4,7 +4,7 @@ tags: [naverworks, email, briefing, timeout, failure-observability]
|
||||
|
||||
**날짜**: 2026-03-09
|
||||
**작성자**: Codex
|
||||
**상위 원칙**: [문서 작성 원칙](../../book/300_architecture/312_writing-principles.md), [백엔드 구조 원칙](../../book/300_architecture/311_백엔드_구조_원칙.md)
|
||||
**상위 원칙**: [문서 작성 원칙](../../book/300_architecture/312_writing-principles.md), [Backend Coding Principles](../../book/300_architecture/311_backend_coding_principles.md)
|
||||
|
||||
## 관련 문서
|
||||
- [9시 네이버 이메일 분석 미전송과 실패 은닉 해결](../troubleshooting/260309_9시_네이버이메일분석_미전송_실패은닉_해결.md)
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
# OpenClaw 아키텍처 분석 및 로빙 적용 리서치
|
||||
|
||||
**작성일**: 2026-02-05 (260226 보완)
|
||||
**참고**: 312_writing-principles.md, 311_백엔드_구조_원칙.md
|
||||
**참고**: 312_writing-principles.md, 311_backend_coding_principles.md
|
||||
**원본**: https://github.com/openclaw/openclaw
|
||||
**로컬 클론**: `ivada/openclaw` (260226 클론)
|
||||
|
||||
@ -123,7 +123,7 @@ OpenClaw(구 Moltbot/Clawdbot)는 WhatsApp·Slack·Telegram 등 메신저로 대
|
||||
|
||||
## 6. 참고 문서
|
||||
|
||||
- 311_백엔드_구조_원칙.md: 계층 분리, LangGraph 워크플로우
|
||||
- 311_backend_coding_principles.md: 계층 분리, LangGraph 워크플로우
|
||||
- 312_writing-principles.md: 핵심만 간결, 파일명:줄번호
|
||||
- 360_로빙_컨테이너_경량화_전략.md: Stateless Router + Microservices
|
||||
- orchestration_tools/250925_langgraph_vs_n8n_comparison.md: LangGraph vs n8n
|
||||
|
||||
@ -67,5 +67,5 @@
|
||||
## 참고
|
||||
|
||||
- 계획 문서: `plans/260102_실제_필요한_플랜_정리.md` (Phase 2)
|
||||
- 원칙 문서: `book/300_architecture/311_백엔드_구조_원칙.md`
|
||||
- 원칙 문서: `book/300_architecture/311_backend_coding_principles.md`
|
||||
|
||||
|
||||
@ -5,7 +5,7 @@ tags: [naverworks, email, briefing, scheduler, timeout, fallback]
|
||||
**날짜**: 2026-03-09
|
||||
**작성자**: Codex
|
||||
**관련 파일**: `rb8001/app/services/skills/naverworks_briefing.py`, `rb8001/app/scheduler/jobs/naverworks_briefing.py`, `skill-email/services/naverworks_provider.py`
|
||||
**상위 원칙**: [문서 작성 원칙](../../book/300_architecture/312_writing-principles.md), [백엔드 구조 원칙](../../book/300_architecture/311_백엔드_구조_원칙.md)
|
||||
**상위 원칙**: [문서 작성 원칙](../../book/300_architecture/312_writing-principles.md), [Backend Coding Principles](../../book/300_architecture/311_backend_coding_principles.md)
|
||||
|
||||
## 관련 문서
|
||||
- [9시 네이버 이메일 분석 미전송 실패 은닉 리서치](../research/260309_9시_네이버이메일분석_미전송_실패은닉_리서치.md)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user