입사 초기 어려웠던 경험…
- 처음 입사하였을 때 코드로만 기능 및 정책 파악이 어려웠던 경험이 있습니다.
- 적용되어 있는 정책이나 문서화 되어있지 않아, 팀 동료들에게 물어보고 다녔습니다.
- A에게 물어보면, B가 알고 있다고 답변
- B에게 물어보면, C가 알고 있다고 답변
- C는 퇴사자라 히스토리 추적 불가능했습니다.
- 개발하는 시간보다, 기존 기능 파악에 많은 시간을 소모했었습니다.
장바구니 기능의 서버 이전과 동시에 문서화를 결정
- 기존 장바구니는 클라이언트에서 구현되어 있는 상태였습니다.
- 위 문제를 해결하기 위해 서버 이전이 결정되었고, 백엔드 개발을 담당하게 되었습니다.
- 또한, 과거 겪었던 경험을 다른 사람도 똑같이 느끼지 않도록 문서화를 결정하였습니다.
실제 장바구니 서버 이전 코드 변경량
- 커밋수 250, 새로 생성된 파일 100개 이상
- 별도 브랜치에서 작업하였기 때문에, 한 번에 많은 코드가 합쳐집니다.
- 다른 개발자가 코드로만 정책 파악하는데에 많은 시간이 소비됩니다.
문서화 적용 결과
-
문서의 일부 사진입니다.
정책 및 요구사항 도출 후 정리의 일부
모듈에 대한 설명 및 의도
패키지 구조
코드에서 사용하는 용어 정리
-
README.md 예시(토글)
-
대략적인 플로우 및 정책 (토글)
문서화를 통해 얻은 것
- 문서 제공을 통해 대략적인 플로우 예측이 가능합니다.
- 기능 파악 시 문서를 참고하며 더 쉽게 기능 및 의도 파악이 가능합니다.