등급 임시 테이블 스키마에 활성 회원 고유 키 반영
목차
문서 작업을 진행했음. tb_grade_temp_revert 정본에 active_member_sn + uk_grtr_active_member 반영.
변경 파일: SQL 파일 1개
작성 목적
코드에서 바로 읽기 어려운 정책, 설계 결정, 운영 규칙을 문서로 남겼음. "왜 이렇게 구현했는가"에 대한 배경을 기록해두지 않으면 나중에 다시 처음부터 고민하게 됨.
DDL 문서화
테이블 정의와 컬럼 설명을 통합 SQL 파일에서 관리함. 테이블 생성 SQL에 주석을 달아두면 스키마만 봐도 의도를 파악할 수 있음.
-- 잔액 감사 이력 (언제, 누가, 얼마나 바뀌었는지)
CREATE TABLE tb_partner_balance_audit (
id BIGINT AUTO_INCREMENT PRIMARY KEY,
source_id BIGINT NOT NULL COMMENT '원본 거래 ID',
delta BIGINT NOT NULL COMMENT '변동액 (음수=차감)',
actor VARCHAR(50) COMMENT '처리 주체',
created_dt DATETIME NOT NULL
);
문서 작성 원칙
- Why 중심: What보다 Why가 더 중요함
- 예시 포함: 추상적 설명보다 구체적인 케이스로 설명
- 업데이트 책임: 코드 바뀌면 문서도 같이 업데이트
- 버전 관리: 문서도 코드처럼 git으로 이력 관리
내부 정책 문서는 코드와 마찬가지로 버전 관리 대상임. 나중에 "이 규칙은 어디서 왔지?"라는 질문에 답할 수 있어야 함. 정책이 바뀌었다면 변경 이유와 날짜도 함께 기록하는 것이 좋음.
다음
댓글 0
첫 댓글 달아줘.