기술 설계 · 양식
아키텍처 다이어그램 양식
서버·DB·연동 구성 등 시스템 아키텍처를 외부 도구에서 그린 그대로 붙여 보관한다.
이럴 때 써요
- 스윔레인·구성도처럼 문서고가 직접 그리지 못하는 그림을 외부 도구에서 이미 그렸을 때
- 서버·DB·연동 구성도 캡처를 설명과 함께 모아 두고 싶을 때
양식 구성
5개 절로 이루어져 있습니다.
- 문서 정보
- 버전 · 대상 · 만든 도구 · 작성자 · 검토자 · 승인자 · 최종 수정일
- 1 다이어그램
- 그림과 설명을 함께 둔다. 그림만 두면 몇 달 뒤 왜 그렇게 그렸는지 아무도 모른다.
- 2 구성 요소
- 그림에 있는 상자를 하나씩 풀어 적는다. 그림만으로는 무엇이 무엇을 책임지는지, 누가 맡는지 전할 수 없다.
- 3 연결 · 데이터 흐름
- 상자 사이 화살표를 적는다. 무엇이 오가는지와 실패했을 때 어떻게 되는지를 함께 적어야 장애 때 쓸 수 있다.
- 4 변경 이력
- 구조가 바뀌면 남긴다. 그림을 새로 그려 덮으면 무엇이 언제 바뀌었는지 알 수 없다.
바로 써 보기
로그인 없이 바로 쓸 수 있습니다. 다 쓰면 PDF·Word·한글(HWPX)·Markdown 으로 내보냅니다.
기술 설계 단계의 다른 양식
- 상태 전이도 — 상태와 전이 규칙, 금지 전이와 알림 발송까지 표로 확정한다.
- 도메인 모델 정의서 — 엔티티·관계·상태를 개발자 기준으로 정의한다. 엔티티가 수십 개로 늘어도 모듈로 나눠 훑을 수 있게 한다.
- 데이터 정의서 — 화면·API 가 공통으로 참조하는 필드의 타입·정의·허용값을 한곳에 고정한다.
- 기술 설계서 (Tech Spec) — 아키텍처, 데이터 모델, API 설계를 개발 착수 전에 합의한다.
- API 명세서 — 엔드포인트별 요청·응답, 공통 에러 코드와 인증 규칙을 계약 수준으로 명세한다.
- 에러 코드 정의서 — 서비스 전체에서 쓰는 에러 코드 체계를 한곳에 고정해, API·배치·화면이 같은 코드를 같은 뜻으로 쓰게 한다.
- 배치 정의서 — 정기적으로 도는 배치·스케줄러 작업의 주기, 처리 로직, 실패 시 대응을 한곳에 정의한다.
- 연동 명세서 — 외부 시스템(파트너사·택배사·PG 등)과 주고받는 데이터의 방식·필드·인증·에러 처리를 계약 수준으로 명세한다.