15

"이거 누가 만든 거야? 아무것도 안 적혀있잖아"

Day 1: 기술 문서화 - 코드를 넘어 이야기를 남겨라

학습 목표

기술 문서화의 필요성을 체감한다 문서 없는 프로젝트가 어떤 결말을 맞이하는지 이해한다

"이거 누가 만든 거야?"

9주간 개발했다. RAG 시스템, Knowledge Graph, 멀티 에이전트, QLoRA 파인튜닝까지. 팀장님 앞에서 데모도 성공적으로 보여드렸다.

그런데 두 달 뒤, 후임자가 배정됐다.

"이 시스템 인수인계 부탁해. 김 대리가 이어받을 거야."

김 대리가 코드를 열었다.

프로젝트 폴더 구조:
├── main.py           (1,200줄, 주석 0줄)
├── utils.py          (800줄, 함수명: do_stuff, process_data, run)
├── model.py          (600줄)
├── test.py           (빈 파일)
├── requirements.txt  (없음)
└── README.md         (# 프로젝트 ← 한 줄)

김 대리의 반응:

"이거... 어떻게 실행하는 건가요?" "환경변수는 뭐가 필요한 거예요?" "이 함수가 뭘 하는 건지 모르겠는데요."

3일 후, 김 대리는 처음부터 다시 만들기로 했다.

9주간의 코드가 쓰레기통에 들어갔다. 코드가 나빠서가 아니다. 문서가 없어서다.


문서 없는 프로젝트의 통계

상황결과
README 없음신규 인원 온보딩 평균 2주 지연
API 문서 없음프론트엔드 개발자와 매일 30분 회의 추가
아키텍처 문서 없음시스템 장애 시 복구 시간 3배 증가
설치 가이드 없음환경 세팅에 반나절 소모

문서는 코드의 보험이다. 코드는 6개월 후에 "남의 코드"가 된다. 심지어 내가 짠 코드도.


제조 AI 프로젝트, 문서가 더 중요한 이유

일반 웹 서비스와 다르다. 제조 AI는 도메인 지식이 코드 안에 녹아있다.

왜 이 온도 임계값이 85도인가?
→ "KOSHA 안전 기준서 제3장 2절에 의거"

왜 이 센서 데이터를 5분 간격으로 수집하는가?
→ "CNC 가공 사이클 타임이 평균 4.5분이므로"

왜 이 에러 코드에 이 조치를 매핑했는가?
→ "2024년 하반기 고장 이력 분석 결과"

이런 **이유(Why)**가 문서에 없으면, 후임자는 코드가 뭘 하는지는 알아도 왜 그렇게 하는지 모른다.


오늘 만들 문서들

문서독자목적
README.md모든 사람프로젝트 첫인상
API 문서개발자엔드포인트 사용법
아키텍처 문서아키텍트/리드시스템 구조 이해
운영 매뉴얼운영자배포/모니터링 절차
도메인 지식 문서후임자왜 이렇게 만들었는가

코드를 넘어 이야기를 남기자. 코드는 "무엇을(What)" 말하고, 문서는 "왜(Why)"를 말한다.

AI로 학습하기 — 꿀팁
기술 문서화 부재 실제 피해 사례 검증AI 학습 팁

문서화 부재의 피해를 실제 사례로 검증하면 문서 작성의 동기부여가 높아집니다. 과장된 주장을 걸러내세요.

'기술 문서화가 없으면 프로젝트가 실패한다'는 주장을 검토해주세요. (1) 실제 소프트웨어/AI 프로젝트에서 문서화 부재로 인한 실패 또는 심각한 지연이 공식적으로 보고된 사례(사내 리포트, 사후 분석 등), (2) 반론: 문서화에 많은 시간을 쓰는 것보다 '코드가 문서다'라는 접근이 스타트업이나 소규모 팀에서 오히려 효율적이라는 주장의 근거, (3) 제조 AI 프로젝트(설비 데이터 파이프라인, 예지보전 모델)에서 문서화가 특히 중요한 구체적 이유(규제, 감사, 인수인계 등)를 균형 있게 분석해주세요.
이 팁이 도움이 됐나요?