[팀 프로젝트] 프로젝트 기록 #1 - 테이블 명세서, API 명세서

 

저번주 목요일부터 팀 프로젝트가 시작되었습니다.

프로젝트 기간동안 한 것과 만났던 에러들을 어떻게 해결했는지 조금씩 기록해 두려고 합니다.

에러 해결 기록은 에러 탭이 차곡 차곡 쌓을 예정입니다.

 

우선 저번주에는 사용자 요구사항 정의서, API 명세서, 테이블 명세서와 같은 문서를 작성하는데 시간을 투자했습니다.

팀원들과 함께 작성한거라 블로그에는 올릴 수 없지만, 멘토님께 피드백 받은 내용이 있어서 기록을 남기려고 합니다.

 

 

 

예를 들어 member 테이블을 생성한다고 했을 때,

이런 식으로 컬럼ID에 member와 언더바를 붙여주었는데

컬럼을 사용할 때 테이블 명도 필요하기 때문에 중복적인 요소라 굳이 붙여줄 필요가 없다는 피드백을 들었습니다.

 

그래서 이렇게 고쳤습니다. 확실히 더 깔끔하고 쓰기 편한 것 같습니다. 

 

 

 

 

그리고 API 명세서 작성할 때도

 처음에 이런 식으로 URI가 중복된다는 걸 놓치고 작성했습니다.

 

tags와 members를 추가하는 방식으로 URI를 수정했습니다.