▶️25분
[영상] 개발자도 글을 잘 써야 한다고요?!
Day 1: 기술 문서화 - 코드를 넘어 이야기를 남겨라
[영상] 개발자도 글을 잘 써야 한다고요?!
발표 & 포트폴리오 > Day 1: 기술 문서화 - 코드를 넘어 이야기를 남겨라
학습 목표
기술 문서가 코드만큼 중요한 이유를 설명할 수 있다 README, 아키텍처 다이어그램, Decision Log 각각의 역할을 구분할 수 있다 독자를 고려한 기술 문서 구조를 설계할 수 있다 제조 AI 프로젝트에 적합한 문서 계층을 구성할 수 있다
영상 핵심 정리 — 개발자도 글을 잘 써야 한다
제조 AI 프로젝트 문서 3종 세트
| 문서 유형 | 독자 | 핵심 질문 | 권장 도구 |
|---|---|---|---|
| README | 모든 사람 | 이 프로젝트가 뭔가? | Markdown |
| 아키텍처 다이어그램 | 개발자·운영자 | 시스템이 어떻게 연결되나? | Mermaid / draw.io |
| Decision Log (ADR) | 미래의 나·팀원 | 왜 이 기술을 골랐나? | Markdown 파일 |
Mermaid 아키텍처 예시
graph LR
Camera['카메라 모듈'] --> Preprocess['OpenCV 전처리']
Preprocess --> Model['YOLOv8 불량 탐지']
Model --> DB[('Neon PostgreSQL')]
Model --> Alert['알림 시스템']
이 다이어그램은 '데이터 흐름'이라는 단 하나의 질문에만 답한다. 배포 구성, 권한 체계 등은 별도 다이어그램으로 분리.
Decision Log 예시
# ADR-003: 비전 모델로 YOLOv8 선택
## 상황
컨베이어 벨트에서 실시간(30fps) 불량 판별이 필요하다.
## 결정
YOLOv8n (Nano 변형) 채택
## 이유
- 추론 속도: 4–6 ms/frame (RTX 3060)
- 커스텀 데이터 파인튜닝 파이프라인 잘 문서화
- ResNet50 대비 동일 정확도에서 파라미터 80% 적음
## 대안 검토
- ResNet50: 정확도 우수, 실시간 처리 불가
- EfficientNet-B0: 정확도↑, 객체 위치 반환 불가
함정 주의: '무엇을 결정했는지'만 쓰고 '왜'를 생략하면 6개월 후 팀원이 같은 고민을 반복한다. ADR 하나에 결정 하나, 이유 반드시 포함.
다음 task와의 연결
다음 reading에서 실제 README 섹션 구성법과 Pinned Repo 전략으로 바로 이어진다.
AI로 학습하기 — 꿀팁
🤖아키텍처 다이어그램 설명 문서 생성AI 학습 팁
AI 에이전트에게 제조 AI 프로젝트의 README와 Decision Log 초안을 작성하게 하고, '왜 만들었나'와 '왜 이 기술을 골랐나'가 30초 안에 전달되는지 점검하세요.
스마트팩토리 예지보전 AI 프로젝트의 README를 작성해줘. '왜 만들었나(문제) + 어떻게 쓰나(실행법)'를 30초 안에 전달하는 첫 섹션과, 아키텍처 다이어그램 한 장에 담을 핵심 질문 하나를 정해줘. Decision Log에는 LSTM 대신 Isolation Forest를 선택한 이유, Neo4j를 선택한 이유 등 '왜 그것을 골랐나'를 중심으로 3개 항목을 작성해줘.
이 팁이 도움이 됐나요?
핵심 포인트
- • README는 '왜 만들었나 + 어떻게 쓰나'를 30초 안에 전달해야 한다
- • 아키텍처 다이어그램은 하나의 질문에 하나의 답만 담는다
- • Decision Log는 '무엇을 결정했나'보다 '왜 그것을 골랐나'가 핵심이다
- • Mermaid 같은 텍스트 기반 도구를 쓰면 다이어그램도 코드 리뷰 대상이 된다
