20221126 TIL 문서화의 중요성

이번 주는 프로젝트를 진행하면서 내가 부족하다고 느끼고 있던 부분인 문서화를
어떻게 하면 더 잘할 수 있을지에도 초점을 두고 진행해보았다.
프로젝트들을 진행해봤을 때 프로젝트 초기에는 문서가 없어도 큰 문제가 없었지만
시간이 지날수록 기억하고 있어야 하는 부분을 까먹게 되면서 문제가 생겼었다.
시간이 지나면서 초기에 계획했던 부분과 달라지는 부분도 있었는데,
이 모든 것을 다 기억하고 관리하는데 문서 없이는 많은 어려움이 있었다.

그래서 항상 진행하는 도중에 '아 그 때 문서를 좀 만들어 둘 껄' 하는 경우가 많았고,
그래서 이번 프로젝트에서는 완성과 함께 문서화를 내가 할 수 있는 수준에서
프로젝트를 진행하는데 도움이 될 수 있게 작성해보려고 노력했다.

그래서 프로젝트를 진행하는 첫날에는 문서에 어떤 내용이 들어가야 될지를 떠올려보고, 템플릿을 먼저 만들었다.
어떤 내용들이 들어가야 될지 떠올리는 데 꽤 오랜 시간이 걸렸고,
노션의 다양한 기능도 사용해보지 않았어서 아래와 같은 템플릿을 짜는데 첫날의 시간을 많이 쓸 수 밖에 없었는데,
결과적으로 매우 좋은 시간 투자였다.

프로젝트를 진행할수록 문서를 많이 찾아보게 되었고,
문서에 기록된 정리된 내용을 바탕으로 개발을 하니 개발을 할 때 내가 작성한 문서만 보고 빠르게 진행할 수 있어
결과적으로 시간을 오히려 아낄 수 있었다.

매일매일 어떤 작업을 했는지 떠올리기가 쉽지 않았기 때문에 계획 및 작업 일지 항목을 만들어 두었고,
개발을 시작하기 전에 오늘 무엇을 할지 먼저 계획을 해서 간략하게라도 작성을 해두고,
작업을 진행하면서 큰 대목들을 작업 내역에 작성해두었다.

그리고 진행하다가 코드가 개선이 되어야 할 것 같은데,
어떻게 하면 좋을지 바로 떠오르지 않는 부분들은 고민되는 부분들 항목에 모아두어
나중에 좋은 아이디어가 떠오르면 해당 부분을 어떻게 해결했는지도 함께 간략하게 적어두었다.

진행하면서 깨닫게 된 부분들, 기억해두면 좋을 것 같은 부분들은 진행하면서 중간중간 회고에 남겼고,
작업을 마치고 나서 기록해둔 것과 하루 동안 느낀점을 바탕으로 회고를 다듬어서 작성했고,
프로젝트를 마무리하고 나서 이 프로젝트를 진행하면서 느꼈던 점을 바탕으로 최종 회고도 남겼다.

그리고 처음에 템플릿을 작성할 때는 고려하지 못했던 기억해야 될 부분들이 프로젝트 진행 중에 생기면
템플릿에 추가하는 방식으로 작업을 진행했다.

모든 것을 다 기억할 수 없고, 혼자서 작업하지 않는 경우가 많기 때문에 문서화는 필수라고 생각한다.
하나 아쉬웠던 점은 작업을 하느라 바빠서 문서를 깔끔하게 작성하지는 못했는데,
앞으로는 문서를 다듬는 시간을 따로 할당해두고, 진행을 해보면 좋을 것 같은 생각이 들었다.
바쁠수록 문서화를 챙기기 어려운데, 문서화를 챙기지 않으면 언젠가 결국 더 큰 문제가 되어 돌아온다.
아무리 바빠도 기록을 잘 남기는 습관을 갖도록 하자.