Skip to content

docs: README 및 데이터 모델링 문서 보강 - #110

Merged
jaehunshin-git merged 1 commit into
developfrom
chore/109-update-readme-and-data-modeling
Jul 17, 2026
Merged

docs: README 및 데이터 모델링 문서 보강#110
jaehunshin-git merged 1 commit into
developfrom
chore/109-update-readme-and-data-modeling

Conversation

@jaehunshin-git

Copy link
Copy Markdown
Contributor

📌 Summary

  • close [docs] README 및 데이터 모델링 문서 보강 #109
  • iOS 팀 README를 참고해 서버의 주요 기능, 기술 스택, 폴더 구조, 로컬 실행 방법과 협업 규칙을 정리했습니다.
  • 시스템 아키텍처 다이어그램과 dbdocs ERD 링크를 README에 추가했습니다.
  • API 멱등성 처리 기록과 썸네일 READY 상태 정합성 제약을 데이터 모델링 문서와 DBML에 동기화했습니다.

✅ Tasks

  • 서버 README 구성 및 내용 보강
  • 시스템 아키텍처 PNG와 원본 SVG 추가
  • README 시스템 아키텍처 및 dbdocs ERD 연결
  • api_idempotency_record 데이터 사전·DBML 반영
  • 썸네일 READY 상태와 오브젝트 키 정합성 제약 문서화
  • 문서 포맷, DBML 문법 및 외부 링크 검증

🔥 Troubleshooting

  • GitHub README에서는 dbdocs의 iframe을 렌더링할 수 없어, 인터랙티브 ERD로 이동하는 링크 버튼을 적용했습니다.

📸 API Test Results

문서 변경이므로 API 호출 테스트는 해당하지 않습니다.

검증 항목 결과
./gradlew spotlessMiscCheck ✅ 통과
npx -y dbdocs validate docs/data-modeling/dbml/zipzip.dbml ✅ 통과
dbdocs·GitHub 이미지 링크 HTTP 응답 ✅ 200

Zipzip 시스템 아키텍처

🔍 To Reviewer

  • README의 기능·기술 설명이 현재 서버 구현과 일치하는지 확인 부탁드립니다.
  • 시스템 아키텍처 다이어그램과 데이터 모델링 문서가 현재 배포·스키마 구성을 정확히 반영하는지 확인 부탁드립니다.

서버 README에 서비스 기능, 기술 스택, 실행 방법과 협업 규칙을 정리하고 시스템 아키텍처 이미지와 dbdocs 링크를 추가한다.

API 멱등성 처리 기록과 썸네일 READY 상태 정합성 제약을 데이터 모델링 문서와 DBML에 동기화한다.

Refs: #109
@jaehunshin-git jaehunshin-git self-assigned this Jul 17, 2026
@jaehunshin-git jaehunshin-git added 🧹 chore 빌드, 설정, 잡무 📝 docs 문서 작성 및 수정 labels Jul 17, 2026
@jaehunshin-git
jaehunshin-git marked this pull request as ready for review July 17, 2026 17:02
@jaehunshin-git
jaehunshin-git merged commit a124488 into develop Jul 17, 2026
2 checks passed
@jaehunshin-git
jaehunshin-git deleted the chore/109-update-readme-and-data-modeling branch July 18, 2026 11:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🧹 chore 빌드, 설정, 잡무 📝 docs 문서 작성 및 수정

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] README 및 데이터 모델링 문서 보강

2 participants