[무작정 게임 퍼블리싱 플랫폼 구축기] 7. 모두를 위한 문서화

시스템에 대한 이해나 경험이 소수의 인원에게만 의존하는 것은 기술 부채라고 생각합니다.

그만큼 기존 인원이나 새로온 사람 모두가 이해할 수 있는 자료가 있고 없고는 업무 효율에 굉장히 많은 차이가 있습니다.

그런 관점에서 회사내에 위키와 같은 문서 시스템이 있고 없고의 차이는 매우 컸는데요,

개발자가 적고 인원이 자주 바뀌는 회사에서 문서화는 매우 중요합니다. 작성된 문서화가 없는 경우, 새로 입사한 개발자들은 시스템 전반적인 이해를 어렵게 느낄 수 있습니다. 또한, 개발자가 퇴사하는 경우, 해당 개발자가 작성한 코드나 시스템의 이해도 없이 새로운 개발자들은 시스템 유지보수를 하게 되므로, 시스템의 안정성 및 유지보수성에 문제가 발생할 수 있습니다.

새로 입사한 개발자들이 빠르게 시스템을 이해할 수 있도록 코드와 함께 문서를 제공하고, 개발자 간의 의사소통을 원활하게 해주며, 이를 통해 개발 프로세스를 더욱 효율적으로 만들어 줍니다. 또한, 퇴사하는 개발자가 남긴 유용한 정보를 문서화하여, 이후 유지보수나 업데이트 시 필요한 정보를 누구나 쉽게 참고할 수 있도록 하고 싶었습니다.

큰회사라면 당연하지만 회사의 체계가 제대로 잡히지 않거나 소규모의 회사일수록 변화가 많아 누군가 원하는사람이 시작을 해야할 경우도 있겠죠. 저의 경우에도 목마른 사람은 개발팀이었고 위키 서버를 운영했습니다.

신규 개발자를 위한 문서화

 

소프트웨어 개발은 다수의 사람들이 참여하게 되고, 수많은 정보가 생산됩니다.

이러한 정보를 적절하게 기록하고 전달하지 않으면, 프로젝트 진행에 큰 문제가 발생할 수 있습니다. 문서화는 이러한 정보를 보존하고, 이해하기 쉽게 전달함으로써, 다른 개발자나 유지보수 담당자들이 프로젝트에 쉽게 참여할 수 있도록 합니다.

마인드 맵으로 표현한 Backend 문서

마인드맵으로 표현한 Database Domain 문서

저같은 경우에는 각 피처의 연관성을 표현하기위해 마인드맵으로 정리를 하기도 했습니다.

팀에서 공용으로 사용하는 문서화 규격이 있다면 팀의 규칙에 따라 맞추는 것이 제일 좋겠죠.

 

다국어 지원은 덤

해당 영역은 비단 기술문서에만 국한되지는 않았습니다. 

좋은 기획서는 커뮤니케이션 비용을 줄이고 개발의 속도를 높여줍니다.

그러기 위해서 일정 형식을 갖춘 문서 템플릿이 필요하다고 생각했고, 

이를 개발팀에서 작성해서 전달해 주기도 했습니다.

 

이처럼 문서화를 통해 

정신없이 업무를 하느라 미뤄두었던 내용을 정리하면서

잘 된 부분과 부족한 부분을 파악하고 개선에 대한 방향성을 잡을 수 있었습니다.

또한 생각을 잘 정리하여 개인적으로 흥미를 느꼈던 분야가 어떤 부분이었는지

곰곰히 생각하면서 커리어를 정리하는 데에도 도움이 되었습니다.

 

마지막으로, 회사를 떠날 때에도 내가 맡았던 일들을 체계적으로 정리할 수 있어서

마무리가 조금 더 아름답게 이루어지지 않았나 개인적으로 생각해봅니다.

 

벌써 귀국한지도 5년이 지나고 있지만

당시 이러한 경험을 바탕으로 포트폴리오같은

나를 표현하는 문서화도 열심히 준비하여

운좋게 또 다른 회사에 취업하였고

또 다른 시행착오들을 겪어나가고 있습니다.

What things are important to me

여러분은 어떤분야에서 어떤 시행착오를 겪고 계신가요?

 

이것으로 "무작정 게임 퍼블리싱 플랫폼 구축기" 시리즈를 마칩니다.

감사합니다.