diff --git a/book/300_architecture/312_문서_작성_원칙.md b/book/300_architecture/312_문서_작성_원칙.md index 5b7d7eb..0f1c880 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 참조 변경) +**수정일**: 2025-12-02 (CLAUDE.md → AGENTS.md 참조 변경), 2026-01-13 (troubleshooting 문서 남은 작업 기록 금지 규칙 추가) **참고**: AGENTS.md, 311_백엔드_구조_원칙.md --- @@ -17,6 +17,7 @@ - 시간순 작성 - 교훈 섹션 필수 - 크기 제한: 섹션 4 참조 +- **⚠️ 절대 금지: 남은 작업 기록** - 남은 작업을 troubleshooting 문서에 기록하면 다음 작업 시 계획이 어수선해짐. 남은 작업은 반드시 `plans/` 문서의 "남은 작업" 섹션에만 기록 **필수 헤더**: ```markdown @@ -61,9 +62,9 @@ - **미구현 항목만 "남은 작업" 섹션에 남기기** - 아키텍처/Phase/필요작업만 기록 **구분** (⚠️ **명확히 구분 필수**): -- `plans/`: 미구현 계획만 (will do) - 부분 완료 포함, **구현 완료 섹션 절대 금지** +- `plans/`: 미구현 계획만 (will do) - 부분 완료 포함, **구현 완료 섹션 절대 금지**, **남은 작업 기록 위치** - `plans/archive/`: 전체 구현 완료된 계획 (참고용 보관) -- `troubleshooting/`: 구현 완료 + 문제 해결 (did + learned) +- `troubleshooting/`: 구현 완료 + 문제 해결 (did + learned), **남은 작업 기록 절대 금지** (남은 작업을 troubleshooting에 기록하면 다음 작업 시 계획이 어수선해짐) ### 인덱스 README.md @@ -120,6 +121,7 @@ | 의사코드, 추측, 예측 ("아마", "것 같다") | 확인된 사실만 기록 | | 이모지 사용 | 명시적 요청 시만 허용 | | 민감정보 직접 기록 (API 키, 비밀번호, JWT Secret Key, 토큰, DB 연결 정보 등) | 보안 위험, 환경변수나 설정 파일로 분리하여 관리 | +| troubleshooting 문서에 남은 작업 기록 | 다음 작업 시 계획이 어수선해짐, 남은 작업은 반드시 `plans/` 문서에 기록 | ### 파일 참조 형식 @@ -164,6 +166,8 @@ ## 교훈 (필수) - 왜 발생했는가 - 다음에 어떻게 방지할 것인가 + +⚠️ **절대 금지**: "남은 작업" 섹션 추가 금지. 남은 작업은 반드시 `plans/` 문서에 기록 ``` ### 아키텍처 문서 구조 @@ -265,9 +269,11 @@ - [ ] 파일명 형식 준수 (yymmdd_주제.md) - [ ] 문서 유형별 크기 제한 확인 (섹션 4 참조) - [ ] 교훈 섹션 작성 (트러블슈팅, 섹션 5 참조) +- [ ] **troubleshooting 문서 작성 시: 남은 작업 섹션 추가 금지** (남은 작업은 반드시 `plans/` 문서에 기록) 문서 작성 후: - [ ] 한 번 더 읽고 핵심 없는 부분/중복 제거 (섹션 2 핵심 원칙 참조) +- [ ] **troubleshooting 문서 검토: "남은 작업" 섹션이 있다면 삭제하고 `plans/` 문서로 이동** --- @@ -288,6 +294,7 @@ 3. **트러블슈팅 문서** (`journey/troubleshooting/`): 구현 과정 기록 (만들면서/만든 후) - 문제 해결, 교훈, 테스트 결과 기록 (섹션 1 참조) - 크기 제한 및 초과 시 처리: 섹션 4 참조 + - **⚠️ 절대 금지: 남은 작업 기록** - 남은 작업은 반드시 `plans/` 문서에 기록 4. **서비스 README.md**: 서비스별 핵심 사항 업데이트 (만든 후) - 엔드포인트, 환경변수, 사용 방법 등 구체적 정보 기록 diff --git a/journey/plans/260112_bayesian_valuation_remaining_tasks.md b/journey/plans/260112_bayesian_valuation_remaining_tasks.md index f0ab24b..2fcb844 100644 --- a/journey/plans/260112_bayesian_valuation_remaining_tasks.md +++ b/journey/plans/260112_bayesian_valuation_remaining_tasks.md @@ -11,7 +11,7 @@ --- -## Phase 3: 추가 작업 +l## Phase 3: 추가 작업 - Beta(α,β) 분포 업데이트 로직 (현재는 mu, sigma만 저장) - 30일 주기 재계산 스케줄러 (scheduler_repository 활용) diff --git a/journey/troubleshooting/260112_bayesian_valuation_phase2_3_implementation.md b/journey/troubleshooting/260112_bayesian_valuation_phase2_3_implementation.md index bff2086..2fc592c 100644 --- a/journey/troubleshooting/260112_bayesian_valuation_phase2_3_implementation.md +++ b/journey/troubleshooting/260112_bayesian_valuation_phase2_3_implementation.md @@ -148,19 +148,6 @@ CREATE TABLE IF NOT EXISTS valuation_premia ( --- -## 남은 작업 (미구현) - -### Phase 2 -- 실제 Likelihood 데이터 파싱 (Neo4j에서 invstSumValText 추출) -- `valuate_startup()` 함수에 `calculate_posterior_with_likelihood` 통합 - -### Phase 3 -- Beta(α,β) 분포 업데이트 로직 (현재는 mu, sigma만 저장) -- 30일 주기 재계산 스케줄러 (scheduler_repository 활용) -- 신규 투자 데이터 자동 재학습 파이프라인 - ---- - ## 참고 - 계획 문서: `plans/251016_bayesian_startup_valuation.md`