Documentation

문서 구조 템플릿

프로젝트 문서를 기획, 정책, 데이터, API, PWA, 테스트, 운영 영역으로 나누어 관리하는 구조입니다.

Copy Block

docs/
  00_project/
  01_planning/
  02_information_architecture/
  03_screen_spec/
  04_policy/
  05_data_model/
  06_api/
  07_frontend/
  08_backend/
  09_pwa/
  10_testing/
  11_operations/

| Area | Contents |
| --- | --- |
| Project | goals, scope, tech stack, writing criteria |
| Planning | service plan, MVP, excluded scope |
| Information Architecture | sitemap, user flows |
| Screen Spec | screens, states, exception cases |
| Policy | domain policies, validation rules |
| Data Model | data structure, relationships, constraints |
| API | common response, error codes, API list |
| Frontend | routing, state management, UI behavior |
| Backend | layers, request and response models, processing flow |
| PWA | manifest, service worker, cache, sync |
| Testing | test cases, QA, regression tests |
| Operations | deployment, monitoring, incident response |

Folder Structure

docs/ 00_project/ 01_planning/ 02_information_architecture/ 03_screen_spec/ 04_policy/ 05_data_model/ 06_api/ 07_frontend/ 08_backend/ 09_pwa/ 10_testing/ 11_operations/

Areas

Area	Contents
Project	목표, 범위, 기술 스택, 작성 기준
Planning	서비스 기획, MVP, 제외 범위
Information Architecture	사이트맵, 사용자 흐름
Screen Spec	화면, 상태, 예외 케이스
Policy	도메인 정책, 검증 기준
Data Model	데이터 구조, 관계, 제약
API	공통 응답, 오류 코드, API 목록
Frontend	라우팅, 상태 관리, 화면 기준
Backend	계층 구조, 요청/응답 모델, 처리 흐름
PWA	Manifest, Service Worker, Cache, Sync
Testing	테스트 케이스, QA, 회귀 테스트
Operations	배포, 모니터링, 장애 대응