20분
도메인 지식 문서 - "왜 이렇게 만들었는가?"를 남겨라
Day 1: 기술 문서화 - 코드를 넘어 이야기를 남겨라
도메인 지식 문서 - "왜 이렇게 만들었는가?"를 남겨라
발표 & 포트폴리오 > Day 1: 기술 문서화 - 코드를 넘어 이야기를 남겨라
학습 목표
코드에 녹아있는 도메인 지식을 추출하는 방법을 이해한다 후임자가 이해할 수 있는 도메인 문서 구조를 파악한다
코드에 숨겨진 "왜"
코드를 보면 무엇을(What) 알 수 있다. 하지만 **왜(Why)**는 코드에 없다.
# 이 코드를 보면
TEMP_THRESHOLD = 85.0 # ??
# 후임자의 의문
# Q: 왜 85도인가? 80도면 안 되나? 90도면?
# A: (코드에 답이 없다)
도메인 지식 문서가 있으면:
## 온도 임계값: 85도
### 근거
- KOSHA 안전 기준서 제3장 2절: "금속 가공 설비의 베어링 온도는
85도를 초과하면 즉시 점검해야 한다"
- 2024년 CNC 고장 이력 분석: 베어링 온도 85도 초과 후
평균 2.3시간 이내 고장 발생 (n=47건)
### 변경 이력
- 2024.03: 초기값 90도 설정
- 2024.07: 고장 분석 결과 85도로 하향 조정
- 변경 승인: 품질관리팀 김 과장
### 관련 문서
- KOSHA-H-72-2024 "기계류의 안전기준"
- 내부 보고서 #MFG-2024-047
도메인 지식 문서 구조
docs/domain/
├── README.md # 도메인 지식 색인
├── error-codes.md # 에러코드 체계와 분류 기준
├── equipment-hierarchy.md # 설비 계층 구조 설명
├── safety-standards.md # 적용된 안전 기준
├── threshold-values.md # 임계값과 그 근거
└── data-sources.md # 데이터 출처와 수집 기준
반드시 문서화해야 할 도메인 지식
| 항목 | 예시 | 왜 중요한가 |
|---|---|---|
| 임계값의 근거 | 온도 85도, 진동 4.5mm/s | 변경 시 안전 위험 |
| 에러코드 분류 기준 | E-CNC-001의 의미 | 새 에러 추가 시 일관성 |
| 데이터 수집 주기 | 5분 간격의 이유 | 비용-정확도 트레이드오프 |
| KG 스키마 설계 이유 | 왜 이 관계를 만들었나 | 스키마 변경 시 판단 기준 |
| RAG 청킹 전략 | 왜 500토큰 청크인가 | 검색 품질에 직결 |
| 모델 선택 이유 | 왜 GPT-4o인가 | 비용/성능 트레이드오프 |
핵심 정리
- 코드는 What, 도메인 문서는 Why를 말한다
- 임계값, 분류 기준, 수집 주기의 근거를 반드시 기록한다
- 도메인 전문가의 의견은 날짜와 출처와 함께 기록한다
- 변경 이력을 남겨야 "왜 바뀌었는지" 추적 가능하다
AI로 학습하기 — 꿀팁
✅도메인 지식 문서 환각 점검AI 학습 팁
AI가 생성한 제조 도메인 지식 문서는 표준 용어와 실제 현장 용법이 혼재하거나 잘못된 인과관계를 서술할 수 있습니다. 특히 불량 원인 분석 로직과 설비 파라미터 관계를 교차 검증하세요.
다음 AI가 작성한 제조 도메인 지식 문서를 비판적으로 검토해줘. 확인 항목: 1) KS·ISO 표준과 상충하는 용어 또는 정의, 2) '→ 이므로 불량 발생' 식의 인과 서술 중 실제 근거가 불명확한 부분, 3) 특정 설비 모델에만 해당하는 내용을 일반화한 과장, 4) 후임자가 그대로 따라했을 때 위험할 수 있는 절차적 오류. 각 항목별로 '의심 구절 → 문제 → 수정 제안' 형식으로 정리해줘: [도메인 지식 문서 붙여넣기]
이 팁이 도움이 됐나요?