기술 설계 · 양식
도메인 모델 정의서 양식
엔티티·관계·상태를 개발자 기준으로 정의한다. 엔티티가 수십 개로 늘어도 모듈로 나눠 훑을 수 있게 한다.
이럴 때 써요
- 엔티티가 늘면서 용어사전 한 절로는 관계·상태를 다 담기 어려울 때
- 새 기능을 설계하기 전에 기존 엔티티가 서로 어떻게 이어지는지 확인할 때
- 용어사전(전사 공유용)과 분리해 개발자만 보는 기술 문서가 필요할 때
양식 구성
5개 절로 이루어져 있습니다.
- 문서 정보
- 버전 · 서비스 · 관련 문서 · 작성자 · 검토자 · 승인자 · 최종 수정일
- 1 엔티티 목록
- 엔티티가 늘어나는 걸 전제로 첫 열에 모듈을 둔다. 표를 모듈 기준으로 정렬하거나 훑으면 전체를 한 화면에 안 띄워도 된다.
- 2 엔티티 관계
- 엔티티 사이 관계를 1:N 처럼 카디널리티까지 적는다. 관계를 말로만 적으면 설계에서 어긋난다.
- 3 상태를 갖는 엔티티
- 전이 규칙 상세는 상태 전이도 문서로 넘기고, 여기서는 어떤 엔티티가 상태를 갖는지만 남깁니다.
- 4 변경 이력
- 엔티티나 관계가 바뀌면 남긴다. 데이터 구조 변경은 되돌리기 어려워 기록이 특히 중요하다.
바로 써 보기
로그인 없이 바로 쓸 수 있습니다. 다 쓰면 PDF·Word·한글(HWPX)·Markdown 으로 내보냅니다.
기술 설계 단계의 다른 양식
- 상태 전이도 — 상태와 전이 규칙, 금지 전이와 알림 발송까지 표로 확정한다.
- 아키텍처 다이어그램 — 서버·DB·연동 구성 등 시스템 아키텍처를 외부 도구에서 그린 그대로 붙여 보관한다.
- 데이터 정의서 — 화면·API 가 공통으로 참조하는 필드의 타입·정의·허용값을 한곳에 고정한다.
- 기술 설계서 (Tech Spec) — 아키텍처, 데이터 모델, API 설계를 개발 착수 전에 합의한다.
- API 명세서 — 엔드포인트별 요청·응답, 공통 에러 코드와 인증 규칙을 계약 수준으로 명세한다.
- 에러 코드 정의서 — 서비스 전체에서 쓰는 에러 코드 체계를 한곳에 고정해, API·배치·화면이 같은 코드를 같은 뜻으로 쓰게 한다.
- 배치 정의서 — 정기적으로 도는 배치·스케줄러 작업의 주기, 처리 로직, 실패 시 대응을 한곳에 정의한다.
- 연동 명세서 — 외부 시스템(파트너사·택배사·PG 등)과 주고받는 데이터의 방식·필드·인증·에러 처리를 계약 수준으로 명세한다.