Files
viberoom-web/docs/README.md

131 lines
5.7 KiB
Markdown

# Docs Index
이 문서는 `web/docs`의 **메인 인덱스**다.
문서를 찾을 때는 항상 여기서 시작한다.
문서 상태는 3가지로 본다.
- `source-of-truth`: 현재 기획/구현의 기준 문서
- `ops`: 작업 운영, 핸드오프, 세션 복구용 문서
- `legacy`: 과거 맥락을 이해할 때만 보는 참고 문서
## 가장 먼저 읽기
새 세션이나 새 에이전트가 들어오면 이 순서로 읽는다.
1. [work.md](./work.md) `source-of-truth`
2. [session_brief.md](./session_brief.md) `source-of-truth`
3. [90_current_state.md](./90_current_state.md) `source-of-truth`
4. [context_core.md](./context_core.md) `ops`
5. 이 문서에서 지금 다루는 화면 섹션 확인
## 제품 전체 기획
화면 하나가 아니라 제품 전체 방향을 볼 때 읽는다.
- [00_project_brief.md](./foundation/00_project_brief.md) `source-of-truth`
- 프로젝트 목적, 범위, 현재 제품 성격
- [12_core_loop_execution_roadmap.md](./product/12_core_loop_execution_roadmap.md) `source-of-truth`
- 어떤 순서로 구현할지 정리한 로드맵
- [16_product_alignment_audit_plan.md](./product/16_product_alignment_audit_plan.md) `source-of-truth`
- 기획-구현 불일치 점검 계획
- [17_product_alignment_findings.md](./product/17_product_alignment_findings.md) `source-of-truth`
- 실제 불일치 ledger
- [08_app_reframe_strategy.md](./screens/app/archive/08_app_reframe_strategy.md) `legacy`
- 초반 `/app` 방향 논의용 아이디어 문서
## 화면별 기획 문서
### `/app`
`/app` 진입 경험, paused gate, review entry를 볼 때 읽는다.
- [screens/app/README.md](./screens/app/README.md) `source-of-truth`
- `/app` current/archive 인덱스
- [19_app_atmosphere_entry_spec.md](./screens/app/current/19_app_atmosphere_entry_spec.md) `source-of-truth`
- `goal + duration + atmosphere` 중심의 새 `/app` 설계
### `/space`
`/space` HUD, refocus, break/return, goal card를 볼 때 읽는다.
- [screens/space/README.md](./screens/space/README.md) `source-of-truth`
- `/space` current/archive 인덱스
- [13_space_intent_card_collapsed_expanded_spec.md](./screens/space/current/13_space_intent_card_collapsed_expanded_spec.md) `source-of-truth`
- 좌상단 목표 카드 구조
### `/stats`
review 구조와 BM 연결을 볼 때 읽는다.
- [screens/stats/README.md](./screens/stats/README.md) `source-of-truth`
- `/stats` current/archive 인덱스
- [14_weekly_review_reframe_spec.md](./screens/stats/current/14_weekly_review_reframe_spec.md) `source-of-truth`
- weekly review를 행동 시스템으로 재정의한 문서
## 플로우 문서
두 화면 이상을 가로지르는 문서는 별도로 관리한다.
- [flows/README.md](./flows/README.md) `source-of-truth`
- [10_refocus_system_spec.md](./flows/current/10_refocus_system_spec.md) `source-of-truth`
- [11_away_return_recovery_spec.md](./flows/current/11_away_return_recovery_spec.md) `source-of-truth`
- [15_app_stats_entry_flow_spec.md](./flows/current/15_app_stats_entry_flow_spec.md) `source-of-truth`
- [18_paused_session_reentry_spec.md](./flows/current/18_paused_session_reentry_spec.md) `source-of-truth`
## 개발 시 참고 문서
구현 규칙이나 구조를 볼 때 읽는다.
- [08_premium_uiux_guideline.md](./foundation/08_premium_uiux_guideline.md) `source-of-truth`
- 세계 최고급(LifeAt, Portal 수준) UI/UX 톤앤매너, 글래스모피즘, 모션 등 프리미엄 디자인 절대 원칙
- [01_ui_guidelines.md](./foundation/01_ui_guidelines.md) `source-of-truth`
- UI 톤, CTA 위계, premium 품질 기준 (일반 가이드)
- [02_arch_fsd_rules.md](./foundation/02_arch_fsd_rules.md) `source-of-truth`
- FSD/레이어 구조 규칙
- [03_routes_map.md](./foundation/03_routes_map.md) `source-of-truth`
- 라우트와 주요 화면 진입점
- [04_coding_rules.md](./foundation/04_coding_rules.md) `source-of-truth`
- 코드 작성 규칙
- [06_commit_convention.md](./foundation/06_commit_convention.md) `source-of-truth`
- 커밋 규칙
## 운영 / 핸드오프 문서
작업 재개, 세션 복구, handoff용 문서다.
- [05_handoff_checklist.md](./ops/05_handoff_checklist.md) `ops`
- [07_session_recovery.md](./ops/07_session_recovery.md) `ops`
- [context_core.md](./context_core.md) `ops`
- [workFlow.md](./ops/workFlow.md) `ops`
- [work.template.md](./work.template.md) `ops`
## 실시간 상태 문서
지금 무엇을 하고 있고, 다음 작업이 무엇인지 볼 때 읽는다.
- [work.md](./work.md) `source-of-truth`
- [session_brief.md](./session_brief.md) `source-of-truth`
- [90_current_state.md](./90_current_state.md) `source-of-truth`
## 빠른 선택 가이드
- `/app`을 수정한다:
- [screens/app/README.md](./screens/app/README.md)
- [19_app_atmosphere_entry_spec.md](./screens/app/current/19_app_atmosphere_entry_spec.md)
- [18_paused_session_reentry_spec.md](./flows/current/18_paused_session_reentry_spec.md)
- [15_app_stats_entry_flow_spec.md](./flows/current/15_app_stats_entry_flow_spec.md)
- `/space` recovery를 수정한다:
- [screens/space/README.md](./screens/space/README.md)
- [10_refocus_system_spec.md](./flows/current/10_refocus_system_spec.md)
- [11_away_return_recovery_spec.md](./flows/current/11_away_return_recovery_spec.md)
- [13_space_intent_card_collapsed_expanded_spec.md](./screens/space/current/13_space_intent_card_collapsed_expanded_spec.md)
- `/stats`를 수정한다:
- [screens/stats/README.md](./screens/stats/README.md)
- [14_weekly_review_reframe_spec.md](./screens/stats/current/14_weekly_review_reframe_spec.md)
- [15_app_stats_entry_flow_spec.md](./flows/current/15_app_stats_entry_flow_spec.md)
- 지금 다음 작업이 뭔지 본다:
- [work.md](./work.md)
- [session_brief.md](./session_brief.md)
- [90_current_state.md](./90_current_state.md)