brunch

매거진 구노하우

라이킷 8 댓글

You can make anything
by writing

C.S.Lewis

계정을 잊어버리셨나요?

by 레드윗 김지원 Aug 11. 2021

[구노하우 6] IT 스타트업의 연구노트 작성법

IT 개발자는 연구노트 어떻게 써야하나요?

안녕하세요 독자님. 블록체인 기반 연구노트 솔루션 ’구노’를 개발하는 레드윗의 김지원 대표입니다.

‘구노하우’는 테크 스타트업을 운영하면서 생긴 노하우와 인사이트를 소개하는 칼럼으로 스타트업 관계자분들께 경험을 공유하고자 합니다.

IT 개발자는 연구노트 어떻게 써야하나요?

제가 연구노트 서비스를 하면서 가장 많이 듣는 질문은 “IT 서비스 개발 중인데 연구노트를 어떻게 써야할 지 모르겠어요” 입니다. 과제를 진행하면서 모든 기록이 코드에 있는데 어떤 방식으로 연구노트를 작성해야 되는지에 대한 문의입니다. 저도 IT 스타트업을 운영하면서 똑같은 고민을 한 적이 있었습니다. 여러 시행착오 끝에 저희 회사에서 사용하는 연구노트 작성법에 대한 공유를 드리겠습니다.

답은 프로젝트 관리 방식에 있다

개발자의 모든 기록은 정말 코드 안에만 있을까요?

사실 개발팀에서 생성되는 기록은 꽤 많습니다. 개발은 단독으로 하는 경우보다 같이 하는 경우가 많아 협업 프로세스에 따라 다양한 방식의 작성되는 기록들이 생겨납니다. 저희 회사의 예시를 들자면, 개발팀은 사전에 일주일 단위의 개발 계획들을 정하고 이 계획을 어떻게 실현할 생각인지에 대한 개발 계획서를 작성합니다.

계획서를 바탕으로 깃헙(Github)을 통해서 PR(Pull Request, 각자의 작업공간) 생성하고 다른 개발자들이 리뷰를 하거나 코멘트를 달아줍니다. 이러한 작업들이 모여서 하나의 큰 작업을 이루면 전체 작업 흐름을 문서화하여 정리합니다. 정리를 하는 이유는 나중에 다른 개발자들이 보고 수정해야 하는 상황이거나 코드를 발전시켜 다듬고자 할 때 참고하는 용도입니다.

이런 프로젝트 관리 방식에서 생겨나는 기록은 1)각자의 역할 분담 문서 2)개발 계획서 3)리뷰와 코멘트 4)개발 종료 후 문서 등이 있습니다.

각 회사마다 개발팀 협업 프로세스가 상이하지만, 협업 단계를 쪼개어 보면 그 안에서 생겨나는 기록들이 생각보다 많을 겁니다. 연구노트라는 게 따로 작성해야 되는 것이 아닌, 일을 진행하면서 생성되는 기록에 대한 관리를 의미하기에 코드를 리뷰하는 등의 작은 과정 하나하나가 모두 연구노트가 될 수 있습니다.

IT 스타트업 연구노트 작성 사례

앞서 말씀드린 저희 개발팀 프로세스 중 생성되는 연구노트를 보여드리겠습니다.

1) 개발 업무 분담 문서
하단 이미지는 매주 개발팀이 각자 맡은 역할과 일정을 분배하는 과정을 정리한 표입니다. 팀원들의 진행 상황들도 연구노트가 될 수 있습니다. 이 문서들을 PDF로 추출하거나 작성 날짜와 시간(시점)을 적어 두는 것이 연구노트 관리에 도움이 될 수 있습니다.

레드윗 개발 업무 분담 문서

2) 개발 계획서 혹은 개발 완료 정리 문서
개발을 하기 전에 어떻게 할 것인지 공유하는 문서 또는 회의록도 연구노트가 될 수 있습니다. 또한 추후에 인수인계를 위한 개발 완료 정리 문서 역시 연구노트로 활용할 수 있습니다. 레드윗에서는 노션(문서 협업 툴)이란 툴을 이용해 작성하고, 필요할 때 pdf로 추출하여 관리하고 있습니다.

레드윗 개발 완료 문서

3) 코드 리뷰
코드 전체가 아닌 깃헙 안에서 생성되는 기록도 있습니다. 바로 본인의 Commit, Issue 생성도 있으며 다른 개발자가 진행하는 리뷰와 코멘트도 있습니다. 하지만 모든 기록을 일일이 추출하기 어렵기 때문에 구노 웹 서비스(연구노트 관리 툴)로 자동연동을 이용하고 있습니다. 매일 밤 12시에 연동한 repository의 commit history, comment, issue가 자동 생성되어 개발자들은 깃헙 안에서만 작업을 해도 연구노트가 생성이 됩니다. 별도의 연구노트 작성이나 시간을 할애하지 않더라도 자동 연동으로 깃헙 안에 있는 기록되어, 추후 pdf 추출, 캡처 등을 통해 IT서비스 기술 개발의 과정을 증명할 수 있습니다.