[Pre-Project] 회고 : 기초적인 문서작업을 마쳤다.

👉🏻 기초 문서작업 (뼈대) 완성

프로젝트가 다가올 수록 문서작업에 대한 고민이 많았다.

생각나는 거라고는 데이터베이스 diagram(ERD)과 API 문서 정도였다.

다행히 코드스테이츠에서 프로젝트 팀이 결성되고 바로 문서에 대한 가이드를 제공해 주었다.

어떤 문서를 작성하는 것이 좋고 어떤 방식으로 하면 좋은지 프론트, 백엔드 모두 이해할 수 있도록 안내를 받았다.

프론트엔드 개발자가 작성해야하는 문서에 대해서는 몰랐는데 화면정의서라는 것을 처음으로 알게 되었다.

백엔드에서 작성해야할 문서는 API 명세서와 데이터베이스 명세서이다.

어제 작성을 마친 사용자 요구사항 정의서를 토대로 API 명세서를 먼저 작성하였다.

처음엔 API 명세서는 프론트 엔드 팀원분들과 같이 작성을 하다가 백엔드에서 작성하고 넘기는게 효율적일 것 같다는 의견이 나와서 백엔드 팀원분과 같이 작성했다.

API 명세서를 반드시 Spring Rest Docs를 사용할 필요는 없고 데이터베이스 명세서도 반드시 ERD로 만들 필요는 없다고 해서 문서화작업을 최대한 빠르게 마치고 코딩으로 넘어가기 위해서 간단하게 필수기능만 작성하기로 했다. 

데이터베이스 명세서는 API 명세서의 데이터를 토대로 작성하는 거라서 다른 팀원분이 ERDcloud 라는 쉽고 직관적인 사이트를 알려주셨다. 내가 알던 dbdiagram.io는 테이블과 칼럼, 속성 등을 sql문으로 작성해야 했는데...ERDcloud는 너무 편했다. 엔티티를 그리는 것도 편하고 작업을 개인이 아닌 팀으로 설정하면 팀원을 추가해서 같이 작업할 수 있다! 데이터베이스 명세서는 백엔드 다른 팀원분이 맡아서 해주신다하셔서 너무 감사했다. (안그래도 할일이 밀린데다 오랜 회의로 피로가 많이 누적되 있었다.) 그리고 몇 시간전에 완성된 것을 확인했다. 😄 

프론트엔드 팀원분들도 화면정의서를 필수기능 위주로 간단하게 작성해주셨다. 사실 굉장히 빠르게 마치셔서 놀랐다. 우리 팀의 프론트 분들의 작업속도가 빠른 편인 것으로 보인다. ㅎ 

다행히 문서 작업이 예상보다 굉장히 빠르게 끝났다!!!

우리의 목표는 이번주 내로 끝내는 거였는데 시작한지 몇일 안된 오늘 (수요일)에 끝났다..!ㅠㅠ 팀원분들 만세ㅠㅠ

👉🏻 5명으로 시작해서 몇일만에 4명으로 줄었다..ㅠ

저번주 금요일에 프로젝트 팀이 정해지고 이번주부터 제대로 프로젝트에 돌입했는데 팀원 한분이 자리를 비우고 회의에도 참석하지 않았는데 하차하신다는 연락을 받았다.ㅠㅠ 사정이 있어서 그런거지만 아쉬운 건 어쩔 수가 없었다. 다른 팀에선 1명이 하차해서 공중분해 되서 다 다른 팀으로 배정되었다는 얘기를 들었는데... 우리는 다행히 한명이 하차해도 백엔드 2명, 프론트엔드 2명으로 다른 팀과 인원차이가 안나기 때문에 그대로 진행할 수 있었다.