20

도메인 지식 문서 - "왜 이렇게 만들었는가?"를 남겨라

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

학습 목표

코드에 녹아있는 도메인 지식을 추출하는 방법을 이해한다 후임자가 이해할 수 있는 도메인 문서 구조를 파악한다

코드에 숨겨진 "왜"

코드를 보면 무엇을(What) 알 수 있다. 하지만 **왜(Why)**는 코드에 없다.

에디터 로딩 중...

도메인 지식 문서가 있으면:

에디터 로딩 중...

도메인 지식 문서 구조

에디터 로딩 중...

반드시 문서화해야 할 도메인 지식

항목예시왜 중요한가
임계값의 근거온도 85도, 진동 4.5mm/s변경 시 안전 위험
에러코드 분류 기준E-CNC-001의 의미새 에러 추가 시 일관성
데이터 수집 주기5분 간격의 이유비용-정확도 트레이드오프
KG 스키마 설계 이유왜 이 관계를 만들었나스키마 변경 시 판단 기준
RAG 청킹 전략왜 500토큰 청크인가검색 품질에 직결
모델 선택 이유왜 GPT-4o인가비용/성능 트레이드오프

핵심 정리

  1. 코드는 What, 도메인 문서는 Why를 말한다
  2. 임계값, 분류 기준, 수집 주기의 근거를 반드시 기록한다
  3. 도메인 전문가의 의견은 날짜와 출처와 함께 기록한다
  4. 변경 이력을 남겨야 "왜 바뀌었는지" 추적 가능하다