본문 바로가기
📁 [4] 개발자 정보 & 코드 노트/팩폭하겠습니다.

✅ 문서화를 안 하면 다음에 욕먹는다

by wawManager 2025. 4. 28.

 

 

처음엔 다들 이렇게 말한다.
"지금 당장 급하니까요."
"이건 기억나겠죠 뭐~"
"어차피 나만 할 거라서요."

그렇게 문서 없이 시작한 프로젝트
3개월 뒤, 누가 물어본다.

“이거 왜 이렇게 했어요?”
“이 구조 뭐였죠?”
“API 문서 어디 있어요?”

그때 드는 생각?
“아... 쓸 걸 그랬다.”


🔹 1. 기억은 한 달이면 증발한다

"이건 당연한 로직이니까 설명 안 해도 돼."
"변수명이 친절하니까 금방 알지 뭐~"

그랬던 당신.
한 달 뒤 본인도 못 알아본다.
✔ 함수 의도 까먹고
✔ 예외처리 이유 기억 안 나고
✔ 검색해도 안 나오는 본인 특유의 처리

결국 주석 보면서 본인이 본인을 욕하게 된다.


🔹 2. 코드 리뷰할 때 제일 많이 욕먹는다

리뷰어:
"이건 왜 이렇게 했어요?"
"요건 요구사항 어디에 있었죠?"
"네이밍 이거 좀…"

답변:
"그게 그러니까요…"
"그땐 급해서…"

문서 없는 PR은 리뷰어를 피곤하게 만든다.
그리고 그 피로는 평판으로 돌아온다.
“얘는 설명이 부족해.”
“같이 일하면 헷갈려.”


🔹 3. 인수인계 때 고통 100배

팀원 한 명 퇴사.
혹은 내가 다른 프로젝트로 이동.
그 순간 문서화는 갑자기 ‘해야 하는 것’이 된다.

근데?
✔ 정리 안 돼 있음
✔ 커밋도 뒤죽박죽
✔ 설계 흐름 아무도 몰라

그때부터 시작된다.
“왜 정리가 안 돼 있죠?”
“이건 도입 배경이 뭐였나요?”
“문서라도 좀 남겨주시지…”

이때 욕 먹는다. 진짜로.


🔹 4. 잘 만든 문서는 그 자체로 실력이다

코드만 잘 짜는 사람이 아니라
✔ 의도를 남기고
✔ 흐름을 보여주고
✔ 나중에도 이해되게 설명한 사람

그게 진짜 “잘하는 개발자”다.
왜냐면
팀은 ‘같이 일하기 좋은 사람’을 찾기 때문이다.


✍️ 마무리하며

문서화는 귀찮다. 맞다.
근데 안 하면
✔ 나중에 내가 고생하거나
✔ 남이 욕하거나
✔ 팀 전체가 비효율로 망한다

좋은 문서는 시간을 줄이고,
욕을 막고, 평가를 올린다.

그냥 코딩보다,
"왜 그렇게 했는지"를 남기는 게 진짜 일이다.