본문으로 건너뛰기

SleepZ Frontend 요구사항 구조

이 디렉터리는 SleepZ(가칭)의 프런트엔드 요구사항과 설계를 체계적으로 관리하기 위한 전용 공간입니다. 백엔드 도메인 명세는 docs/domains/에서, 애플리케이션 전반의 개요와 아키텍처는 docs/application/dha-sleep-web/overview.md에서 관리하되, 프런트엔드 관련 세부 항목은 아래 구조를 따릅니다.

상위 구조​

  • web/: 백엔드 기능 검증용 웹 프런트엔드. 기능 중심의 화면, 관리자/케어팀 내부용 워크플로우, 개발/QA 시나리오를 다룹니다.
  • mobile/: 실제 사용자 배포용 모바일 앱. 환자 및 케어팀을 위한 제품화 요구사항, UX 전략, 릴리스 가이드라인을 다룹니다.

각 하위 디렉터리는 동일한 관례를 따른 별도의 README를 가지고, 세부 문서를 아래와 같이 구성합니다.

문서 배치 가이드​

  • ux-flows/: 사용자 여정, 스토리보드, 화면 전환 순서 등 UX 흐름을 설명하는 문서를 배치합니다.
  • component-specs/: 디자인 시스템, UI 컴포넌트 명세, 상태/데이터 매핑 규칙을 정리합니다.
  • integration-guides/: 프런트엔드에서 백엔드 API 및 외부 서비스와 상호작용하는 방식을 다루는 문서를 둡니다.
  • testing-strategy.md: UI·E2E 테스트 전략, 접근성 기준, TimeMachine 기반 모킹 전략 등을 기술합니다.

작성 원칙​

  1. 문서는 모두 한국어로 작성합니다.
  2. 파일명은 kebab-case를 사용하고, 섹션은 마크다운 헤더로 계층 구조를 명확히 합니다.
  3. TimeMachine, 권한 모델, 도메인 이벤트 등 백엔드 의존성이 있을 경우, 해당 참조 문서 경로를 명시합니다.
  4. 신규 문서를 추가할 때는 overview 문서나 관련 README에 링크를 남겨 탐색성을 확보합니다.

이 구조를 기반으로 프런트엔드 요구사항을 확장하면, 백엔드 도메인 문서와 역할이 명확히 분리되어 유지보수성과 협업 효율이 높아집니다.