[네컷로그] 1. 사이드 프로젝트 기획 및 설계(ERD, API명세서, 기능명세서)

개발 사이드 프로젝트를 진행하다보면 기획 및 설계 단계를 그냥 스루하는 경우가 많은데 이번에 진행하는 프로젝트에는 기획자가 있기도 하고, 처음부터 끝까지 모든 것을 다 경험해보겠다는 목표가 있었기 때문에 기획과 설계 단계부터 전부 차근차근 진행해보았다.

 

미흡한 점이 많지만 그런 부분들은 프로젝트를 진행하면서 차차 보완하기로 하고 ERD와 API 명세서, 기능명세서를 작성했다.

 

 

 

---

네컷로그(4cut-log) 프로젝트

네컷 사진을 아카이빙할 수 있는 모바일 애플리케이션

인생네컷, 포토이즘, 포토그레이, 모노맨션 등 다양한 브랜드의 인화사진 부스에서 찍은 사진들을 한 곳에 아카이빙하여 관리할 수 있도록 도와주는 서비스이다.

사실 세컷, 네컷, 여섯컷 등 다양한 형태가 있지만, 대부분의 사람들이 "네컷 찍으러 가자!"라고 말하는 것처럼 이해하기 쉽게 '네컷 사진'이라고 지칭하기로 했다.

 

 

네컷로그 주요 기능

- 인증/인가 _ 로그인, 회원가입(SNS OAuth2.0, Spring Security 기반) 

- 마이페이지 _ RUD

- 네컷로그 _ CRUD

- 앱 버전 _ R

 

ERD

 

ERD는 vscode의 extension으로 작성했다.

원래는 ERD Cloud 라는 무료 웹사이트에서 작성했는데 디자인이 너무 맘에 안들어서 더 깔끔한 ui를 찾다가 발견했고 깔끔하면서 보기 좋아서 이걸 사용하기로 !

 

아직까지는 JPA를 활용한 테이블과 쿼리 기반의 테이블의 차이를 명확하게 인지하지 못하고 있기 때문에 일단은 지금까지 내가 해왔던 것 처럼 테이블을 설계하고 테이블들을 조인했다.

그치만 JPA를 사용하면서 분명히 수정할 부분이 생길 것으로 예상이 된다 , , , 

이 부분에 대해서는 개발을 하면서 더 공부하고 보완해야할 것 같다 !!

 

---

API 명세서

네컷로그 API 명세 | Notion

 

API 명세서는 노션으로 작성했다.

기능, method, URI(path)를 MVP 기능을 중심으로 작성했고,

이후 추가되는 기능에 대해서는 계속 수정해나갈 예정이다.

 

 

사실 아직 request와 response 부분에 대해 완벽하게 작성하지 못했는데 이는 설계를 완벽하게 진행한 것이 아니라,, 개발을 진행하면서 보완하면서 진행할 것이다..

 

---

기능 명세서

네컷로그 기능명세서 | Notion

 

기능 명세서도 노션으로 작성했다.

기능 명세서 또한 MVP 기능을 중점으로 작성했기 때문에 비교적 간단하다.

작성하다보니 회의하면서 나왔던 다양한 기능들이 있어서 다 작성하려다가

일단 MVP 기능을 구현해서 앱 출시를 하는 것이 우선이라는 생각에 전부 쳐내고 기본에 충실하게 작성했다!

 

 

---

이렇게 기획 및 설계 부분을 간단하게 마무리했다 -

간단하다고 말했지만,, 생각보다 시간이 오래 걸렸고.. 안해본 것들을 하려고 하니까 헷갈리고 어렵게 느껴졌다.

개발을 진행하면 많은 수정이 이루어질 것으로 예상이 되고 ,, 특히 ERD 부분은 많이 바뀔 수 있지 않을까 싶다

 

 

모든 자료에 대한 피드백은 언제나 환영이니 많관부 !!

댓글 남겨주삼.