명세서 작업

배경

---

최근에 캠프 교육을 들으면서 코딩을 다시 시작하게 되었다. 이전 국비 과정에서는 정신없이 듣기도 했고 프로젝트 참여자들이 모두 비전공자여서 각자 살기 바빴다. 명세서 작성은 물론 github 사용 조차도 제대로 모르는 상태! 하지만 이번에는 그렇게 되지 않기 위해 배운 내용도 정리할 예정이다.

 

 

내용

---

정처기 실기를 공부할 때도 단순히 자격증을 따기 위해 외웠던 부분인 '요구사항 분석'과 '명세서 작성'.

실제로 이렇게 작업을 할까? 싶었지만, 진짜로 이렇게 작업을 하는 것 같다. 지금 듣는 교육과정에서의 '요구사항 분석'부분은 보여줄 수가 없겠지만, 팀원들과 만들어낸 'API 명세서'와 '테이블 명세서', 'ERD 명세서', '인프라 명세서'를 여기에 되새겨보고 정리를 해보자.

 

 

API 명세서 (노션 작성)

https://www.notion.so/API-136dcca716cf808aa2fdee25878f0747?p=136dcca716cf80af969acd0108368b9e&pm=s

주문 생성 | Notion

 

다른 팀들은 어떻게 작성했는지는 모르겠으나, endpoint와 request elements, response elements, 요청 예시, 응답 예시(성공/실패) 이렇게 나누어서 상세하게 작성하니 정말로 서비스 코드 작성을 할 때 복잡한 머리가 한결 편해진 느낌이 든다.

 

테이블 명세서 (노션 작성)

https://www.notion.so/136dcca716cf80b4a7c4d54428eed000

 

ERD 명세서 만들기 전 테이블 명세 작업을 하면서 필드에 어떤 값들이 들어가야 하고, 테이블간 관계에 대해 간단히 생각해 보면서 정리가 가능하다.

 

 

ERD 명세서 (ERD Cloud)

ERD 명세 작업때 사용한 erd cloud

 

테이블간의 관계를 시작적으로 구성해보니 entity구성 때 헷갈리는게 정말 많이 없어졌다. 연관관계를 대체 어떻게 설정할지 설계를 할 떄는 정말 머리가 아파왔지만 정리하고 나면 정말 좋은 명세서인 듯.

 

인프라 명세서

프로젝트 구조

 

CI/CD 구조

 

전체적인 시스템의 구성도를 볼 수 있다. 처음에는 완전 아무것도 몰랐지만 이제는 그래도 어떤 구성으로 흘러가는지 알게 된것 같다. 이번에는 CI/CD라는 것도 맡아서 해보기로 했는데 잘 할 수 있을까? 해보자!