보이지 않는 로직의 문서화

이 게시물은 일본 배달 서비스 데마에칸의 배달 과정에서 보이지 않는 배차 로직을 읽을 수 있는 문서로 만드는 과정을 설명합니다.

문서화의 필요성

• 배달 과정의 핵심인 Engine 시스템의 동작이 코드로만 존재해 이해와 소통이 어려움
• 최종 정책 파악이 힘들고, 서로 다른 용어 사용으로 혼란 발생
• 커뮤니케이션 비용 절감과 정책 명확화를 위해 정책서 작성 필요

문서 작성 과정과 원칙

• 빠짐없이 담기, 찾기 쉽고 읽기 쉽게 작성
• 로직 흐름은 따르되 문서를 분리하여 과도한 분량 방지
• Engine 동작만 다루고 다른 컴포넌트 내용은 링크로 대체
• 중복된 정보 관리 최소화 및 정책 일원화

정책서 도입 효과

• 팀 간 이해도 증진 및 QA 검증 기준 확보
• 시스템 개선 시 영향 범위 명확화
• 명확한 용어 정립과 소통 효율 증가
• 기획자가 Engine 스펙 전반을 이해하고 관리 가능해짐