방금 넘겨받은 크고 문서화되지 않은 코드베이스를 이해하는 데 어떻게 접근합니까?

Question

Accepted Answer

문서화되지 않은 코드베이스를 넘겨받았을 때, 모든 파일을 위에서 아래로 읽거나 보기 흉한 부분을 리팩터링하려는 충동을 참으십시오. 당신은 아직 그것을 이해하지 못했고, 제대로 이해하지 못한 코드를 성급하게 리팩터링하는 것이 바로 장애를 만드는 방법입니다. 목표는 추측이 아니라 실제 동작으로부터 정확한 멘탈 모델을 빠르게 구축하는 것입니다.

## 실용적인 접근

- **먼저 로컬에서 실행하라.** 빌드하고 실행되게 만드는 것은 로직을 한 줄 읽기 전에 stack, dependency, 그리고 setup의 고통 지점을 가르쳐 줍니다.
- **하나의 실제 사용자 흐름을 끝에서 끝까지 추적하라.** 구체적인 것(login, checkout, 보고서)을 골라 entry point에서 database까지 그리고 다시 돌아오는 흐름을 따라가십시오. 하나의 흐름을 깊이 이해하는 것이 열 개를 훑는 것보다 낫습니다.
- **data model을 읽어라.** schema와 핵심 도메인 객체는 시스템이 실제로 무엇을 하는지, 개념들이 어떻게 연결되는지를 드러내며, 종종 코드보다 더 정직합니다.
- **entry point을 찾아라.** route, controller, message consumer, cron job, main 함수. 이것들이 시스템으로 들어가는 문입니다.
- **test와 logging으로 동작을 확인하라.** log 한 줄이나 breakpoint를 추가하고 가정하는 대신 현실을 관찰하십시오. 기존 test는 의도된 동작을 문서화합니다.
- **그것을 아는 사람과 대화하라.** 그 결정들을 겪은 사람과의 30분은 며칠간의 발굴 작업을 아껴 줍니다. *무엇*만이 아니라 *왜*를 물으십시오.
- **진행하면서 지도를 적어라.** module, 흐름, 함정을 적어 나가는 문서는 당신의 노력을 다음 사람과 미래의 당신이 재사용할 수 있는 것으로 바꿔 줍니다.

## 피해야 할 것

이해하기 전에 리팩터링하지 마십시오. 동작보다 주석을 믿지 마십시오. 전체 시스템을 한 번에 머릿속에 담으려 하지 마십시오. 중요한 부분에서의 깊이가 모든 곳에서의 얕은 넓이보다 낫습니다.

## 왜 중요한가

대부분의 엔지니어링 작업은 다른 사람이 작성한 코드에서 일어납니다. 낯선 시스템의 멘탈 모델을 빠르고 안전하게 구축할 수 있는 tech lead는 팀 전체의 막힘을 풀어주고, 작업을 정확히 산정하며, 아직 이해하지 못한 것을 바꾸는 값비싼 실수를 피합니다.