문서 작성 시 신경 쓰는 부분은 무엇인가요?

문서가 거의 없는 레거시 프로젝트에 처음 합류했을 때의 경험이 문서화의 중요성을 실감하게 했습니다.

구조를 파악하는 데 예상보다 훨씬 오랜 시간이 걸렸고, 같은 질문을 여러 사람에게 반복해서 물어야 했습니다. 핵심 결정 이유가 기록으로 없으니 왜 이렇게 만들었는지 알 수 없어서 수정 범위를 가늠하기 어려웠습니다.

그 경험 이후로 새로 만드는 것에는 의사결정 배경을 꼭 남기는 습관이 생겼습니다. 문서는 나중에 합류하는 사람에게 보내는 편지라는 시각이 그때 만들어졌습니다. 의사결정 배경을 남기는 습관이 나중에 합류하는 사람의 시간을 아껴준다는 걸 배웠습니다. 왜 그 결정을 했는지가 나중에 코드를 이해하는 열쇠가 된다. 나중에 합류한 사람도 빠르게 파악할 수 있도록 남겨두는 게 기본이 됐습니다.