팀 프로젝트 설계 1- 문서관리
프로젝트를 진행하는데 있어서 사람이 많아질수록 문서는 중요하다. 여러 명이 개발을 하기 위해서 많은 규칙들이 필요하고, 이를 참고할 문서가 언제든지 바로바로 확인 할 수 있어야 최대한 소스코드를 짜는데 집중할 수 있다. 그리고 현재의 진행 사항이 공유되어야 소스 코드가 아닌 문서를 보고 빠른 이해를 할 수 있다. 물론 문서 만드는 것에 너무 공을 들이는 것도 시간을 많이 빼앗길 수 있기 때문에, 프로젝트에 필요한 문서들 중 최소한으로 작성할 수 있는 사항 먼저 정의하였다. 그리고 매주 진행하면서 발생할 수 있는 이슈 및 공유할 사항들은 반드시 기록 남겼다.
프로젝트 전체 문서 관리
개발에 필요한 문서들은 서랍에 있는 서류처럼 자주자주 꺼내보면서 활용하기 마련이다. 이때 어떤 서류가 어디에 있는지 잘 정리가 되어있어야, 불필요한 시간 사용을 최소화 할 수 있다. 문서화를 위해 사용한 툴은 노션, gitbook, 파워포인트 이다. 나름의 회사에서 문서화를 위해 사용했던 노하우를 녹여서 문서를 관리했고, 꽤나 많은 문서들이 생겨났다. 아래의 캡쳐된 이미지 처럼 기획/설계, 개발 참고, 프로젝트 로드맵, 공지/Tip, 회의록 등으로 카테고랑징 하였다.
기획 / 설계
프로젝트를 착수하는 단계에서 검토하고 협의하였던 사항에 대해서 기록하였다. 프론트엔드 개발자의 경우 백엔드 개발자가 작업한 API를 이해하기 쉽게 작성된 문서가 필요하고, 백엔드 개발자도 전체 서비스의 기획이 정해져야 설계하고 이를 개발할 수 있기 떄문에 양쪽에서 참고해야하는 문서를 정리하는 섹션이다.
- 프론트 기획문서 예시 (파워포인트)
- API 설계 문서 예시 (Gitbook)
- 데이터 베이스 테이블 구조 설계 예시(노션)
개발 관련 참고 페이지
각 플랫폼 별로 최초에 소스 코드 개발에 필요한 규칙 및 검토한 기술에 대해 정리한 내용이다. 개발을 하다보면 소스 코드 규칙에 대한 혼동이 자주 발생할 수 있기 때문에 이를 상기 시켜줄 수 있는 참고 문서이다. 그리고 특정 팀원이 검토한 기술에 대해 다른 팀원에게 공유해야 하는 부분이 있기 때문에 이를 문서화 시키고 여기에서 참조하도록 하였다.
일정 및 Task 관리
프로젝트 전체적인 로드맵과 매주 진행한 진척 사항에 대한 공유를 했다. 현재 어디까지 개발했고, 앞으로 무엇을 개발해야 하는지 대략적인 가이드라인 필요하기 때문이다. 따라서 프로젝트가 시작하기 전에 전체적인 로드맵을 작성했고, 매주 리뷰 시간에 한주동안 진행 사항을 기반으로 차주 예정 사항을 매번 결정 하였다. 그와 동시에 각 팀의 팀장과 팀원간의 협의를 통해 아래와 같이 일정관리에 바로바로 문서화 시켰다.
문서화를 하면서 느낀점
문서를 작성하는 건 참 어려운 작업이다. 문서 하나를 작성하는데 소요되는 시간도 꽤나 걸리고, 이를 한번에 이해하기 쉽게 작성하는 것도 쉽지 않다. 심지어 문서의 사소한 오타로 인해 이를 읽는 팀원의 작업을 지연시키기도 하는 일이 발생하곤 한다. 그래도 프로젝트의 처음으로 다시 돌아갈 수 있다면, 좀더 꼼꼼히 문서화를 했더라면 하는 아쉬움이 남는다. 조금 더 시간이 걸리더라도 이를 확실히 해야 나중에 불필요한 삽질을 하는 수고도 덜 수 있고, 문서를 쓰는 사람도 읽는 사람도 갈등을 줄일 수 있기 때문이다. 완벽하게 문서를 작성 하기란 쉽지 않지만, 그래도 시작을 했다면 본인이 전달하고자 하는 의미를 제대로 전달해야 문서로서 제 역할을 할 수 있고, 그렇지 않다면 오히려 안하는 것보다 더 부작용을 초래할 수 있다.
