docs(docs): 문서를 화면과 용도별 폴더로 재구성
This commit is contained in:
36
docs/ops/05_handoff_checklist.md
Normal file
36
docs/ops/05_handoff_checklist.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# 05. Handoff Checklist
|
||||
|
||||
Codex CLI가 중단되거나 컨텍스트가 초기화된 뒤 재개할 때 사용하는 체크리스트.
|
||||
|
||||
## 재개 시작 (5분)
|
||||
|
||||
1. `docs/README.md`에서 지금 작업할 화면 섹션과 우선 읽기 문서를 확인
|
||||
2. `git status --short`로 작업 트리 상태 파악
|
||||
3. `docs/work.md`와 `docs/90_current_state.md`의 현재 우선순위를 확인
|
||||
4. 화면 작업이면 해당 source-of-truth spec을 추가로 읽는다
|
||||
- `/app` -> `19`, `18`, `15`
|
||||
- `/space` -> `10`, `11`, `13`
|
||||
- `/stats` -> `14`, `15`
|
||||
|
||||
## 구현 중 체크
|
||||
|
||||
1. 뷰 로직 누수 여부 확인 (`page.tsx` 조합 유지)
|
||||
2. 레이어 import 방향 위반 여부 점검
|
||||
3. 파일 500줄 초과 여부 점검
|
||||
4. UI 톤(감성/저자극)과 CTA 위계 유지 확인
|
||||
|
||||
## 종료 전 체크
|
||||
|
||||
1. 타입체크 또는 빌드 최소 1회 실행
|
||||
2. 변경 파일 경로/의도 요약 정리
|
||||
3. `docs/90_current_state.md` 갱신:
|
||||
- DONE
|
||||
- NEXT
|
||||
- RISKS
|
||||
- CHANGED FILES
|
||||
|
||||
## 커밋 단위 가이드
|
||||
|
||||
- 1커밋 1의도 원칙
|
||||
- 구조 변경(FSD)과 스타일 변경(UI)은 가능하면 분리
|
||||
- 커밋 메시지는 "무엇을 왜 바꿨는지" 중심으로 작성
|
||||
41
docs/ops/07_session_recovery.md
Normal file
41
docs/ops/07_session_recovery.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# 07. Session Recovery
|
||||
|
||||
## 결론
|
||||
|
||||
커밋 이력 기반 복구는 가능하다.
|
||||
다만 커밋만 의존하면 "왜/다음 할 일/리스크"가 누락되기 쉬우므로 아래 하이브리드 방식을 기본으로 쓴다.
|
||||
|
||||
## 권장 방식 (Hybrid)
|
||||
|
||||
1. 커밋 메시지: Conventional + 세션 트레일러(한국어)
|
||||
2. 상태판: `docs/90_current_state.md` 유지
|
||||
3. 복구 커맨드: `npm run session:recover`
|
||||
|
||||
이 3가지를 함께 쓰면, 새 세션에서 3~5분 안에 맥락 복구가 가능하다.
|
||||
|
||||
## 복구 절차
|
||||
|
||||
1. `npm run session:recover`
|
||||
2. `docs/90_current_state.md`의 `NEXT` 1순위 확인
|
||||
3. `git show <최근 커밋>`로 세부 diff 확인
|
||||
|
||||
## 커밋 예시
|
||||
|
||||
```text
|
||||
docs(session): 세션 복구 워크플로우와 커밋 템플릿 추가
|
||||
|
||||
맥락:
|
||||
- codex cli 중단 시 작업 맥락 손실을 줄이기 위해
|
||||
|
||||
변경사항:
|
||||
- docs/foundation/06_commit_convention.md 추가
|
||||
- docs/ops/07_session_recovery.md 추가
|
||||
- scripts/session/recover-context.sh 추가
|
||||
|
||||
검증:
|
||||
- bash scripts/session/recover-context.sh
|
||||
|
||||
세션-상태: 복구 문서와 스크립트가 준비됨
|
||||
세션-다음: 다음 기능 커밋부터 동일 포맷 적용
|
||||
세션-리스크: 과거 커밋에는 세션 트레일러가 없음
|
||||
```
|
||||
81
docs/ops/workFlow.md
Normal file
81
docs/ops/workFlow.md
Normal file
@@ -0,0 +1,81 @@
|
||||
# WorkFlow
|
||||
|
||||
너는 이 레포의 유지보수 엔지니어다.
|
||||
사용자가 `workFlow.md를 실행해`라고 지시하면 아래 순서대로 수행한다.
|
||||
|
||||
## 0) 입력 확인
|
||||
|
||||
1. `docs/work.md`를 읽고 작업 목록을 파악한다.
|
||||
2. 비어 있거나 모호한 항목이 있으면 최소 질문 1회로 명확히 한다.
|
||||
|
||||
## 1) 필수 컨텍스트 로드
|
||||
|
||||
토큰 절약을 위해 기본 로드 + 조건부 로드로 나눠서 읽는다.
|
||||
|
||||
### 기본 로드 (항상)
|
||||
|
||||
- `docs/work.md`
|
||||
- `docs/session_brief.md`
|
||||
|
||||
### 조건부 로드 (필요할 때만)
|
||||
|
||||
- UI/카피/CTA 변경이 있으면 `docs/foundation/01_ui_guidelines.md`
|
||||
- 구조/FSD/레이어 변경이 있으면 `docs/foundation/02_arch_fsd_rules.md`
|
||||
- 커밋 직전에 `docs/foundation/06_commit_convention.md`
|
||||
- 현재 상태 상세가 필요하면 `docs/90_current_state.md`
|
||||
- 핵심 규칙 상세가 필요하면 `docs/context_core.md`
|
||||
- 규칙 충돌/모호함이 있으면 `docs/foundation/00_project_brief.md`, `docs/foundation/04_coding_rules.md`
|
||||
|
||||
## 2) 구현 원칙 (강제)
|
||||
|
||||
- FSD 레이어 규칙을 지킨다.
|
||||
- `page.tsx`에는 조합만 두고 비즈니스 로직을 넣지 않는다.
|
||||
- UI 상태(토글/선택)만 최소 허용한다.
|
||||
- 파일 500줄 이상이면 분리한다.
|
||||
- 실제 기능(타이머/오디오/서버/DB) 구현은 하지 않고 UI 목업 + 더미 + 토스트로 처리한다.
|
||||
- 작업 지시 범위를 벗어난 파일은 수정하지 않는다.
|
||||
|
||||
## 3) 실행 순서
|
||||
|
||||
1. `work.md`의 `작업 1`부터 처리한다.
|
||||
2. 작업 단위마다 아래를 수행한다.
|
||||
- 코드 수정
|
||||
- 검증 실행 (`work.md`의 검증 항목 우선)
|
||||
- 요구사항 충족 여부 자체 점검
|
||||
3. 여러 작업이 있으면 동일 절차를 반복한다.
|
||||
|
||||
## 4) 커밋 규칙 (강제)
|
||||
|
||||
- 주제별 1커밋 원칙을 지킨다.
|
||||
- 커밋 메시지는 한국어로 작성한다.
|
||||
- 형식은 `Conventional Commits`를 따른다.
|
||||
- 예: `feat(app): 허브 CTA를 데스크톱 컴팩트 그룹으로 변경`
|
||||
- 커밋 본문은 아래 구조를 사용한다.
|
||||
|
||||
```text
|
||||
맥락:
|
||||
- ...
|
||||
|
||||
변경사항:
|
||||
- ...
|
||||
|
||||
검증:
|
||||
- ...
|
||||
|
||||
세션-상태: ...
|
||||
세션-다음: ...
|
||||
세션-리스크: ...
|
||||
```
|
||||
|
||||
- 커밋에는 관련 파일만 스테이징한다.
|
||||
|
||||
## 5) 종료 정리
|
||||
|
||||
1. `docs/90_current_state.md` 업데이트
|
||||
- DONE / NEXT / RISKS / CHANGED FILES
|
||||
2. `docs/session_brief.md`를 최신 상태로 압축 갱신
|
||||
- 현재 우선순위 / 최근 세션 상태 / 리스크
|
||||
3. 최종 보고에는 아래를 포함한다.
|
||||
- 작업별 반영 내용
|
||||
- 실행한 검증 결과
|
||||
- 생성된 커밋 해시/제목 목록
|
||||
Reference in New Issue
Block a user