기술 설계 · 양식
배치 정의서 양식
정기적으로 도는 배치·스케줄러 작업의 주기, 처리 로직, 실패 시 대응을 한곳에 정의한다.
이럴 때 써요
- 재고 마감, 정산처럼 매일·매시 자동으로 도는 작업이 늘어나 무엇이 언제 도는지 한눈에 안 보일 때
- 배치가 실패했을 때 누가 무엇을 확인해야 하는지 미리 정해야 할 때
- 배치 간 실행 순서·의존관계 때문에 장애가 난 적이 있을 때
양식 구성
7개 절로 이루어져 있습니다.
- 문서 정보
- 버전 · 서비스 · 관련 문서 · 작성자 · 검토자 · 승인자 · 최종 수정일
- 1 배치 목록
- 도는 배치를 한곳에 모은다. 주기는 사람이 읽을 수 있게 적고 Cron 식도 함께 남긴다.
- 2 처리 로직 상세
- 배치마다 절을 나누지 않고, 표 첫 열에 배치명을 적어 한 표로 관리합니다.
- 3 의존 관계 · 실행 순서
- 앞 배치가 끝나야 도는 것을 적는다. 순서를 안 적으면 데이터가 반쯤 처리된 채로 남는다.
- 4 실패 처리 · 재시도
- 실패를 무엇으로 판정하고 몇 번 다시 돌릴지 적는다. 수동 재실행 방법까지 적어야 새벽에 당황하지 않는다.
- 5 모니터링 · 알림
- 무엇을 보고 이상을 알아챌지 적는다. 배치는 조용히 안 도는 것이 가장 위험하다.
- 6 변경 이력
- 주기나 처리 내용이 바뀌면 남긴다.
바로 써 보기
로그인 없이 바로 쓸 수 있습니다. 다 쓰면 PDF·Word·한글(HWPX)·Markdown 으로 내보냅니다.
기술 설계 단계의 다른 양식
- 상태 전이도 — 상태와 전이 규칙, 금지 전이와 알림 발송까지 표로 확정한다.
- 아키텍처 다이어그램 — 서버·DB·연동 구성 등 시스템 아키텍처를 외부 도구에서 그린 그대로 붙여 보관한다.
- 도메인 모델 정의서 — 엔티티·관계·상태를 개발자 기준으로 정의한다. 엔티티가 수십 개로 늘어도 모듈로 나눠 훑을 수 있게 한다.
- 데이터 정의서 — 화면·API 가 공통으로 참조하는 필드의 타입·정의·허용값을 한곳에 고정한다.
- 기술 설계서 (Tech Spec) — 아키텍처, 데이터 모델, API 설계를 개발 착수 전에 합의한다.
- API 명세서 — 엔드포인트별 요청·응답, 공통 에러 코드와 인증 규칙을 계약 수준으로 명세한다.
- 에러 코드 정의서 — 서비스 전체에서 쓰는 에러 코드 체계를 한곳에 고정해, API·배치·화면이 같은 코드를 같은 뜻으로 쓰게 한다.
- 연동 명세서 — 외부 시스템(파트너사·택배사·PG 등)과 주고받는 데이터의 방식·필드·인증·에러 처리를 계약 수준으로 명세한다.