📁 Side Project Documentation Guidelines
이 가이드라인은 프로젝트의 기획부터 설계, 트러블슈팅까지의 전 과정을 체계적으로 기록하기 위해 작성되었습니다. 각 파일은 프로젝트의 전문성을 보여주는 핵심 문서가 됩니다.
- 프로젝트 타이틀 & 슬로건: 한눈에 들어오는 이름과 서비스의 정체성.
- 핵심 요약 (Introduction): 문제 해결 및 기획 배경 (2~3줄).
- 핵심 기능 (Key Features): 사용자 중심 기능 3~4개 (아이콘 활용).
- 기술 스택 (Tech Stack): 사용 언어, 프레임워크, DB 등.
- 문서 바로가기 (Documentation): 01~04번 파일 링크 및 설명.
- 버전 관리 (Changelog): v1.0, v1.1 등 주요 업데이트 요약.
📂 01_concept_and_requirements.md (기획 및 요구사항)
- 기획 의도 (Why): 프로젝트 시작 동기 및 문제 정의.
- 타겟 유저 (Persona): 서비스 대상 정의.
- 핵심 기능 (Must-have): 필수 구현 기능 상세.
- 확장 기능 (Nice-to-have): 추후 고도화 및 AI 에이전트 적용 계획.
🏗️ 02_system_architecture.md (시스템 아키텍처)
- 아키텍처 다이어그램: 시스템 구성 구조 설명.
- 데이터 흐름 (Data Flow): 요청부터 응답까지의 이동 경로.