기술 설계 · 양식
기술 설계서 (Tech Spec) 양식
아키텍처, 데이터 모델, API 설계를 개발 착수 전에 합의한다.
이럴 때 써요
- 개발 착수 전에 아키텍처와 데이터 모델을 합의할 때
- API 설계를 문서로 남겨야 할 때
양식 구성
7개 절로 이루어져 있습니다.
- 문서 정보
- 버전 · 대상 시스템 · 작성자 · 검토자 · 승인자 · 작성일
- 1 설계 개요
- 무엇을 어떻게 만들지 요약한다. 선택한 방식과 함께 고른 이유를 적으면 나중 리뷰가 쉬워진다.
- 2 시스템 아키텍처
- 구성 요소와 그 사이 흐름을 적는다. 외부 의존(결제·메일·저장소)을 빠뜨리지 않는다.
- 3 DB 스키마 설계
- 이번에 만들거나 바꾸는 테이블만 적는다. 전체 스키마는 데이터 정의서에 둔다.
- 4 API 명세
- 이 기능이 새로 여는 엔드포인트를 적는다. 인증이 필요한지 한 칸으로 분명히 한다.
- 5 보안 및 인프라
- 배포·모니터링·권한처럼 만들고 나서 필요한 것을 적는다. 여기 비면 출시 직전에 몰린다.
- 6 변경 이력
- 문서를 고칠 때마다 한 줄 남긴다. 승인 뒤에 바뀐 것은 특히 빠짐없이 적는다.
바로 써 보기
로그인 없이 바로 쓸 수 있습니다. 다 쓰면 PDF·Word·한글(HWPX)·Markdown 으로 내보냅니다.
기술 설계 단계의 다른 양식
- 상태 전이도 — 상태와 전이 규칙, 금지 전이와 알림 발송까지 표로 확정한다.
- 아키텍처 다이어그램 — 서버·DB·연동 구성 등 시스템 아키텍처를 외부 도구에서 그린 그대로 붙여 보관한다.
- 도메인 모델 정의서 — 엔티티·관계·상태를 개발자 기준으로 정의한다. 엔티티가 수십 개로 늘어도 모듈로 나눠 훑을 수 있게 한다.
- 데이터 정의서 — 화면·API 가 공통으로 참조하는 필드의 타입·정의·허용값을 한곳에 고정한다.
- API 명세서 — 엔드포인트별 요청·응답, 공통 에러 코드와 인증 규칙을 계약 수준으로 명세한다.
- 에러 코드 정의서 — 서비스 전체에서 쓰는 에러 코드 체계를 한곳에 고정해, API·배치·화면이 같은 코드를 같은 뜻으로 쓰게 한다.
- 배치 정의서 — 정기적으로 도는 배치·스케줄러 작업의 주기, 처리 로직, 실패 시 대응을 한곳에 정의한다.
- 연동 명세서 — 외부 시스템(파트너사·택배사·PG 등)과 주고받는 데이터의 방식·필드·인증·에러 처리를 계약 수준으로 명세한다.