[개발] 의외로 주니어가 할 수 있는 것: 문서화 문화 도입

 

문서화는 정말 중요해요!!! 중요하다구요!!!

라고 말만 한다면,

실제로 문서화 문화가 조성될 확률 === 0%

 

그럼 어떻게 하나요?

직접 실천합니다.

"일단 나부터"

 

---

앞선 몇 가지의 글에서도 말했지만

나는 ✨fancy legacy✨ 위에서 코딩하고 있다

(레거시 굉장해 엄청나!)

 

보통 코드 맥락은 읽어서 파악할 수 있다고 하는데

...

 

"코드? 네가 직접 경험하기 전까지 아무것도 믿지 마"

오죽하면 이게 우리 팀 유행어겠슨

 

그래서 결국은 사람이 그 맥락을 다 읽어서 파악하는 수밖에 없는데

너무 복잡하다 보니까... 구전설화 형태로 전해짐

'ㅇㅇㅇ 기능 관련 코드를 어떤 키워드로 찾으면 좋을까요?'
'아 그거... ㅇㅇ님(퇴사자)이 알고 계시는데...'

 

퇴사하면 구전설화가 끊겨서 전해지지 못함

누군가 코드를 다시 읽어서 그 맥락을 이해하기 전까지 '죽은 코드'가 됨

 

레거시 읽기 해 본 사람은 알겠지만 시간 진짜 훅 지나감

그리고 읽고 나면 기능 개발할 시간 얼마 안남아서 후다다두다닥 급하게 만들게 됨

이걸 모든 신규 입사자가 겪는다면... 시간이 얼마나 낭비되는 것임?

크아악 우리 아까운 엔지니어 인재들의 시간이 녹고 있어

 

그럼 답은 뭐다?

 

"문서화"

 

어차피 코드 읽을 거, 내가 방금 읽은 내용을 노션에 바로 정리하면서 읽는다

 

나는 주니어.

주니어가 가진거? 젊음, 시간, 열정, 끈기.

 

그럼, 내가 시간 쏟아서 문서 정리해두면,

최소 내 다음 사람부터는 내가 레거시 읽기에 쓴 시간만큼 아껴서,

기능 개발에 시간 쏟고 로직 고도화하겠지?

그럼...언젠가 이 레거시도 리팩토링이 다 되겠지?

 

---

문서화 문화의 서막

 

때는 7월 말.

ab test를 걸기 위해 신규 플랫폼(퇴사 분이 세팅하고 나가심.. 이마저도 퇴사자의 유산이라니....)을 쓰고자 했다

근데 다들 잘 안쓰고 있고, 나도 처음 써보고, 뭔지 모르겠음...

 

"이거 어케 쓰는지 아세요?"

라고 우리 스쿼드, 타 스쿼드... 네 분이 넘는 개발자분들께 지식 동냥(?)을 하고 다녔음

(내 속마음: 안돼 나 이거 내일 출시해야 하는데 엉엉 왜 안돼)

 

한바탕 고생하고 나니까, 뭔가 되긴 됐음

 

그리고 나서 바로 든 생각: "아 이거 문서 써야겠다"

 

노션을 켜서 프론트 챕터 섹션에 새 페이지 하나 만듦

거기에 'ab test 플랫폼 사용법 공유'라고 제목을 적고

방금 내가 주워들은 지식을 순서대로 정리해서 a to z 사용법을 적음

 

일단 이게 세팅이 되어있는 데도, 안쓰는 이유는

1. 어떻게 쓰는지 모름
2. 배워서 쓸만큼 시간 여유 없음

 

이 두 가지일 것이라고 생각함! 그럼... 이것만 해결해주면 되잖아?!

 

그리고, 다음날 오후

(모두가 적당히 안바쁘면서도 엔지니어 전체 채널에 적당히 주목할 수 있는 시간)

문서 작성 소식을 알리는 메시지를 게시함

(2025.07.24 오후 4시 21분)

 

"이번에 좌충우돌 하면서 익힌 사용법을 노션에 정리해두면,
다음에 처음 사용하는 분이 계실 때 쉽게 사용하실 수 있을 것 같아서 노션 문서를 만들었습니다!"

 

의외로 다들 엄청 열정적인 반응을 해주심

(개발자 특: 슬랙에 이모지 많이 찍히면 기분 좋음)

 

그리고, 내가 예상 못한 효과가 같이 따라옴

 

1. 쌉고수 개발자들이 내 문서를 읽고 내가 잘못 이해한 부분을 정정해줌
2. 쌉고수 개발자들이 내 문서를 읽고 앞으로 도입 예정인 기능(몰랐음)을 알려줌
3. 이게 뭔지 몰랐던 타 스쿼드 개발자들도 주목해서 알게 되고, 본인 스쿼드에 도입함

 

순식간에 이 문서에 3명의 기여자가 추가됨

(실시간으로 뚝딱뚝딱 고쳐지는 문서를 보며 감동의 눈물을 흘리는 주니어)

 

내가 잘못 이해한 부분을 정정해주고, 잘못 사용하고 있는 부분을 정정해주고, 앞으로 추가할 기능도 알려줌

상냥한 개발자 선배림들....

 

내가 그냥 혼자 이해하고 말았다면, 내가 잘못 알고 있다는 걸 정정하기까지 꽤 오랜 시간이 걸렸겠지만,

이렇게 문서로 정리해서 공적으로 발표하니 모두가 빠르게 주목해서

정정 및 지식 확산도 정말 빠르게 이뤄졌다고 생각함

 

그리고 후에도 계속 이 문서는 업데이트가 되며, 더 알아보기 쉽고 쓰기 편한 방법으로 바뀌었다고 한다...

 

---

두 번째, 개발 환경 세팅 문서 공유

 

웹뷰 개발자 특: RN 세팅도 할 줄 알아야 함

근데 이 RN 세팅이 참 잘 안된다

오죽하면 기능 개발은 2일 만에 했는데 RN 세팅 땜에 고생하다 결국 일주일 후에 출시한 경우도 있었음

 

근데

나도 그런 문제에 봉착해버림

옆집이 무너진 줄 알았는데 내 집이었음 ㅇㅇ

 

프로덕트의 어떤 기능은 웹뷰-RN-백엔드1 순서로 코드를 파악해야 했는데

이걸 위해서는 웹뷰, RN, 백엔드1, 백엔드2를 모두 로컬에 띄워야 했음

본인? 프론트엔드 개발자라 백엔드 로컬 띄울 일 없었음

근데 이제부터 띄워야 됨

 

뭔지 모르겠고 자꾸 백엔드 연결 안되고 튕기고 RN 앱 빌드 했는데 백엔드 연결 안돼서 데이터 안불러와지고

(그냥 흔한 주니어의 삽질)

 

내가 할 수 있는 것:

ai 괴롭히기, 잘 안되면 아는 개발자분들에게 가서 무릎꿇고 한 번만 살려달라고 빌기

 

ai도 모른다고 하길래 결국 개발자분들께 sos 요청함

이것도 돌고 돌아 세 개발자 분의 지식을 조각조각 합쳐서 겨우 띄울 수 있었음

(.env랑 vite.config 파일 세팅 이슈였음)

 

난 다른 분들도 다 알고 있는 줄 알고, 문서 만들까 하다가... 일단 지금 눈앞에 떨어진 기능 개발부터 하기로 함

 

근데 기능 어느정도 만들고 슬슬 정리하고 있을 때(저녁 쯤)

신입 개발자 분이 '로컬 개발 환경 세팅 하셨다고 들었는데, 혹시 어떻게 하셨나요?'라고 물어보심

 

어!? 이거 수요있네? (문서화 할 생각에 신남)

 

일단 구두로 말씀드렸는데

'아 좀 복잡한거군요? 내일 출근해서 할게용'

듣자마자 '앗싸 문서 만들 시간 벌었다 ㅋㅋ'라는 생각이나 했음

 

바로 노션 켜서 개발 환경 세팅 문서 만듦.

설정 화면 캡쳐까지 넣어가며 정성스럽게 작성했다

 

최근 프론트/백을 동시에 확인할 일이 생겨, 로컬 개발 환경을 세팅했습니다.
그 과정에서 시행착오 했던 내용을 바탕으로 아래 문서를 정리했습니다.
오늘 ㅇㅇ님께서 로컬 개발 환경을 처음 세팅하면서 제게 질문을 주셨는데,
문서로 만들어두면 다른 분들께서도 참고하실 수 있을 것 같아 공유합니다.
언제나 그렇듯 혹시 정정/추가가 필요한 부분이 있다면 언제든 피드백 주시면 감사드리겠습니다.
감사합니다!

(2025.08.20. 00:40)

 

신나서 문서 만들다 시간을 못보고 자정 넘어서 올렸는데도, 많은 엔지니어 분들이 환호를 주셨다 (기분 굿)

 

다음날 출근해서 어제 질문 주셨던 분이 따라서 해봤는데 완전 잘된다고 따봉날리심 헤헤

 

그리고 이번에도 예상치 못한 효과가 또 있었는데,

들어온지 1주일도 안된 완전 신규 입사자분이 자리까지 찾아와서 감사하다고 해주심

바로 따라서 해봤는데 세팅 잘됐다고!

 

헤헤 뿌듯했다

 

---

 

타 스쿼드의 문서화 문화 동참

 

한참 싱나게 개발하고 있는데, 타 스쿼드 개발자 분이 디엠주심

"수연님, 저도 머 올렸는데 이모지 눌러줘요"

(2025.09.03. 오후 1시 33분)

 

호다닥 가보니까 문서를!! 올리심

백엔드 개발자가 아니라서 잘 모르겠지만, 모니터링 시스템 관련 문서였다

실제 운영 환경에서 얻은 노하우를 정리했다고 쓰셨음

 

이걸 읽은 인프라 리드분이 "우리가 원하는 방향성대로 제일 Fit하게 가고 있네요!'라고 하심

(이거 극찬 아님니까) (내가 괜히 대신 뿌듯하고 막 그래)

 

바로 이모지 10개 눌러드리고 폭풍칭찬 해드림

내가 문서 공유한 거 보고 자기도 올려보고 싶었다고 하시는 데 뭔가 뿌듯했음

 

그리고, 2주 뒤

타 스쿼드 프론트 개발자 분(위 개발자 분이랑 같은 팀)이 채널에 문서를 업로드하심

 

우리 스쿼드와 타 스쿼드가 공통으로 쓰는 라이브러리를 업데이트를 했으며,

사용법을 노션에 a to z로 정리해 공유해주셨다

(2025.09.18. 오후 8시 30분)

 

바로 문서 정독하고 따봉따따봉 누름

ㄹㅇ

 

---

 

내가 7월 24일에 문서 올리기 전까지는 이런 분위기의 문서 공유를 못봤던 것 같은데

혹시... 나 문서화 문화 만들었나? 라는 그런 김칫국도 마셔보고...~

아무튼... 의외로 주니어도 문서화 문화 만들 수 있을지 모른다

 

일단 해보고! 안되면 또 해!

이 세상 모든 주니어 화이팅!

 

작성: 2025.10.08 19:26