문서 파일 정리
This commit is contained in:
141
docs/README.md
Normal file
141
docs/README.md
Normal file
@@ -0,0 +1,141 @@
|
||||
# 적자 탈출 가계부 프로젝트 문서
|
||||
|
||||
이 디렉토리는 적자 탈출 가계부 프로젝트의 모든 문서를 체계적으로 정리한 곳입니다. 사용자들이 개인 재정을 효과적으로 관리하고 적자 상태에서 벗어날 수 있도록 도와주는 모바일 앱 개발 프로젝트입니다.
|
||||
|
||||
## 프로젝트 개요
|
||||
|
||||
'적자 탈출 가계부'는 단순한 수입/지출 기록을 넘어, 사용자의 소비 패턴을 분석하고 맞춤형 절약 전략을 제안하여 재정 건전성을 개선하는 데 중점을 둔 모바일 앱입니다. AI 기술을 활용한 개인화된 재정 관리 경험을 제공하고, 궁극적으로는 사용자들의 재정적 웰빙을 향상시키는 것을 목표로 합니다.
|
||||
|
||||
## 폴더 구조
|
||||
|
||||
### 00_프로젝트_개요
|
||||
프로젝트의 기본 개요와 목표, 사용자 정의에 관한 문서가 포함되어 있습니다.
|
||||
- `01_프로젝트_소개.md` - 프로젝트 개요 및 주요 기능 설명
|
||||
- `02_핵심_문제_정의.md` - 해결하고자 하는 문제 정의 (예정)
|
||||
- `03_사용자_페르소나.md` - 타겟 사용자 프로필 (예정)
|
||||
- `04_사용자_스토리.md` - 사용자 관점의 요구사항 (예정)
|
||||
- `05_비즈니스_모델.md` - 수익 모델 및 사업화 전략 (예정)
|
||||
- `06_법률_규제_검토.md` - 금융 앱 관련 법규 및 규제 검토 (예정)
|
||||
|
||||
### 01_기획_및_설계
|
||||
프로젝트의 기획 및 UI/UX 설계에 관한 문서가 포함되어 있습니다.
|
||||
- `01_요구사항_분석.md` - 사용자 요구사항 및 기능적/비기능적 요구사항 분석
|
||||
- `02_MVP_기능_목록.md` - 최소 기능 제품(MVP)의 기능 목록 (예정)
|
||||
- `03_주요_사용_시나리오.md` - 주요 사용 사례 시나리오 (예정)
|
||||
- `04_UI_와이어프레임.md` - 핵심 화면 와이어프레임 (예정)
|
||||
- `05_사용자_여정_맵.md` - 사용자 경험 흐름도 (예정)
|
||||
- `06_정보_아키텍처.md` - 앱 구조 및 화면 흐름도 (예정)
|
||||
|
||||
### 02_기술_문서
|
||||
프로젝트의 기술적 구현에 관한 문서가 포함되어 있습니다.
|
||||
- `01_시스템_아키텍처.md` - 시스템 아키텍처 설계 문서
|
||||
- `02_데이터_모델_설계.md` - 데이터 모델 설계 문서 (예정)
|
||||
- `03_API_명세서.md` - API 엔드포인트 명세 (예정)
|
||||
- `04_보안_설계.md` - 보안 및 개인정보 보호 설계 (예정)
|
||||
- `05_성능_최적화_전략.md` - 앱 성능 최적화 전략 (예정)
|
||||
- `06_CI_CD_파이프라인.md` - 지속적 통합/배포 전략 (예정)
|
||||
- `07_AI_ML_구현_전략.md` - AI 기반 소비 패턴 분석 구현 방법 (예정)
|
||||
|
||||
### 03_개발_단계
|
||||
프로젝트 개발 단계별 문서가 포함되어 있습니다.
|
||||
- `01_개발_로드맵.md` - 전체 개발 로드맵 및 일정
|
||||
- `02_1단계_개발_계획.md` - 1단계(MVP) 개발 상세 계획 (예정)
|
||||
- `03_테스트_전략.md` - 테스트 방법론 및 계획 (예정)
|
||||
- `04_배포_전략.md` - 배포 및 운영 계획 (예정)
|
||||
- `05_품질_보증_계획.md` - QA 전략 및 테스트 케이스 (예정)
|
||||
- `06_유지보수_전략.md` - 출시 후 유지보수 및 업데이트 계획 (예정)
|
||||
|
||||
### 04_디자인_가이드
|
||||
UI/UX 디자인 관련 문서가 포함되어 있습니다.
|
||||
- `01_디자인_시스템.md` - 디자인 언어 및 컴포넌트 정의 (예정)
|
||||
- `02_색상_팔레트.md` - 앱 색상 가이드라인 (예정)
|
||||
- `03_타이포그래피.md` - 폰트 및 텍스트 스타일 가이드 (예정)
|
||||
- `04_아이콘_및_이미지.md` - 아이콘 디자인 및 사용 가이드 (예정)
|
||||
- `05_애니메이션_가이드.md` - UI 애니메이션 및 트랜지션 (예정)
|
||||
- `06_접근성_지침.md` - 접근성 디자인 원칙 (예정)
|
||||
|
||||
### 05_프로젝트_관리
|
||||
프로젝트 관리 및 협업 관련 문서가 포함되어 있습니다.
|
||||
- `01_팀_구성.md` - 팀 구성원 및 역할 정의 (예정)
|
||||
- `02_의사결정_프로세스.md` - 프로젝트 의사결정 체계 (예정)
|
||||
- `03_커뮤니케이션_계획.md` - 팀 내 소통 방식 및 도구 (예정)
|
||||
- `04_일정_및_마일스톤.md` - 주요 마일스톤 및 납기일 (예정)
|
||||
- `05_위험_관리.md` - 잠재적 위험 요소 및 대응 계획 (예정)
|
||||
|
||||
### 06_참고자료
|
||||
프로젝트 진행에 참고할 수 있는 자료들이 포함되어 있습니다.
|
||||
- `01_시장_조사_보고서.md` - 가계부 앱 시장 조사 보고서
|
||||
- `02_경쟁사_분석.md` - 주요 경쟁 앱 상세 분석 (예정)
|
||||
- `03_사용자_인터뷰.md` - 잠재 사용자 인터뷰 결과 (예정)
|
||||
- `04_참고_리소스.md` - 유용한 참고 자료 및 링크 (예정)
|
||||
- `05_금융_데이터_소스.md` - 재정 관리 데이터 참고 자료 (예정)
|
||||
- `06_관련_연구_자료.md` - 소비 행동 및 금융 심리학 연구 (예정)
|
||||
|
||||
### 07_마케팅_및_성장
|
||||
마케팅 및 사용자 확보 전략 관련 문서가 포함되어 있습니다.
|
||||
- `01_마케팅_전략.md` - 출시 및 사용자 확보 전략 (예정)
|
||||
- `02_ASO_전략.md` - 앱 스토어 최적화 전략 (예정)
|
||||
- `03_콘텐츠_전략.md` - 콘텐츠 마케팅 계획 (예정)
|
||||
- `04_사용자_유지_전략.md` - 사용자 참여 및 유지 방안 (예정)
|
||||
- `05_파트너십_계획.md` - 잠재적 파트너십 및 협업 기회 (예정)
|
||||
|
||||
## 주요 기능
|
||||
|
||||
1. **수입/지출 기록**: 간편한 UI로 일상 재정 활동 기록
|
||||
2. **카테고리 관리**: 사용자 정의 카테고리로 지출 분류
|
||||
3. **예산 설정**: 카테고리별 월간/주간 예산 설정 및 알림
|
||||
4. **지출 분석**: 차트와 그래프로 소비 패턴 시각화
|
||||
5. **AI 기반 분석**: 소비 패턴 분석 및 맞춤형 절약 제안
|
||||
6. **절약 챌린지**: 사용자 맞춤형 절약 목표 설정 및 달성 보상
|
||||
7. **재정 건강 점수**: 사용자의 재정 상태를 점수화하여 개선 동기 부여
|
||||
8. **구독 관리**: 정기 구독 서비스 추적 및 최적화 제안
|
||||
9. **재정 목표 설정**: 단기/중기/장기 저축 목표 설정 및 진행 상황 추적
|
||||
10. **알림 시스템**: 예산 초과, 주요 지출, 절약 기회에 대한 스마트 알림
|
||||
11. **가계부 보고서**: 정기적인 재정 상태 요약 보고서 제공
|
||||
12. **공유 기능**: 가족 또는 파트너와 특정 재정 정보 공유
|
||||
|
||||
## 기술 스택
|
||||
|
||||
- **프론트엔드**: React, Vite, Tailwind CSS, Capacitor
|
||||
- **백엔드**: Node.js, Express, Supabase(PostgreSQL)
|
||||
- **AI/ML**: TensorFlow, Python
|
||||
- **클라우드**: Supabase On-Premise
|
||||
- **데이터 시각화**: D3.js, Chart.js
|
||||
- **인증/보안**: JWT, OAuth 2.0, 데이터 암호화
|
||||
- **테스트**: Jest, Cypress
|
||||
- **CI/CD**: GitHub Actions
|
||||
- **분석**: Supabase Analytics
|
||||
|
||||
## 문서 작성 가이드라인
|
||||
- 모든 문서는 마크다운(.md) 형식으로 작성합니다.
|
||||
- 파일명은 내용을 명확히 나타내는 한글 또는 영문으로 작성합니다.
|
||||
- 이미지나 다이어그램은 가능한 마크다운 내에 포함시킵니다.
|
||||
- 문서 간 연결이 필요한 경우 상대 경로를 사용하여 링크합니다.
|
||||
- 코드 예시는 적절한 구문 강조와 함께 코드 블록으로 포함합니다.
|
||||
- 변경 사항은 문서 하단의 업데이트 이력에 기록합니다.
|
||||
- 중요 결정사항은 의사결정 배경과 함께 기록합니다.
|
||||
|
||||
## 개발 워크플로우
|
||||
1. **기능 기획**: 사용자 스토리 및 요구사항 정의
|
||||
2. **설계**: UI/UX 디자인 및 기술 아키텍처 설계
|
||||
3. **개발**: 기능 구현 및 단위 테스트
|
||||
4. **코드 리뷰**: 팀원 간 코드 품질 검토
|
||||
5. **테스트**: QA 및 사용성 테스트
|
||||
6. **배포**: 스테이징 및 프로덕션 환경 배포
|
||||
7. **모니터링**: 성능 및 사용자 피드백 모니터링
|
||||
8. **반복**: 피드백을 바탕으로 기능 개선
|
||||
|
||||
## 출시 계획
|
||||
- **알파 버전**: 내부 테스트 (2024년 4월 초)
|
||||
- **베타 버전**: 제한적 사용자 테스트 (2024년 4월 중순)
|
||||
- **MVP 출시**: 앱스토어 및 플레이스토어 공개 (2024년 4월 말)
|
||||
- **기능 업데이트**: 사용자 피드백 기반 주요 기능 추가 (2024년 5월 초)
|
||||
- **확장 계획**: 웹 버전 및 추가 기능 확장 (2024년 5월 중순부터)
|
||||
|
||||
## 업데이트 이력
|
||||
- 2024-03-15: 프로젝트 문서 초기 구성 완료
|
||||
- 2024-03-15: 프로젝트 소개, 요구사항 분석, 시스템 아키텍처, 개발 로드맵, 시장 조사 보고서 추가
|
||||
- 2024-04-01: 폴더 구조 개선 및 추가 섹션(디자인 가이드, 프로젝트 관리, 마케팅) 추가
|
||||
- 2024-04-05: 일정 조정 - 모든 개발 계획을 4월 말까지 완료하도록 수정
|
||||
- 2025-03-09: 개발 방법 변경 - Flutter에서 React, Tailwind CSS, Capacitor 기반 웹 앱으로 전환, Lovable UI 컴포넌트 스타일 적용
|
||||
- 2025-03-09: 데이터베이스 변경 - MongoDB에서 Supabase(PostgreSQL) On-Premise로 전환
|
||||
Reference in New Issue
Block a user