DB명세서 작성법

백엔드 개발하면 DB도 같이 염두해야하는 경우가 잦다. 

단지 개발뿐만이 아니라, 회원가입 이나 게시판 같은거는 DB도 함께 봐야하는 경우가 생긴다. 

그럴 경우에 DB를 굳이 들어가지 않아도 명세서만 보면 파악할 수 있다. 

나 혼자 개발하는게 아니라면, DB설계하는 분은 꼭 DB명세서를 작성해야한다고 생각한다. 

 

파일 96개 모두 엑셀

이렇게 쌓여가는 자료들을 보면 뿌듯한데, 물론 이 폴더에는 쓰는것도 있고, 쓰지 않고 기획,기능변경으로 무산된것들도 많다. 

 

DB 테이블 상세서 원본.xls

0.01MB

내가 사용하는 DB 테이블 상세서 원본이다. 

( 다른 블로그에서 구한거 같은데 혹시 출처아시는분은 댓글로 부탁드립니다ㅠ 

찾으려고 하니까 블로그 못찾겠어요ㅠㅠ 알려주시면 추가할게요 )

 

아래는 내가 실제로 작성한 원본이고, 현재 사용은 안한다. 

설명은 적어주는게 좋은데, 안적으면 이름만 봐서는 정확히 무슨 용도를 위해 만들어진 것인지를 모른다. 

그대로 배껴쓰지는 말고, 예시로만 사용해줬으면 한다. 

 

08.25 QNA테이블 구상.xls

0.01MB

 

그리고 위의 저 파일을 보고 적으면 아래처럼 된다. 

 

CREATE TABLE mb_serviceqna (
	id int(11) comment '테이블 내부 정리 번호' auto_increment,
	category varchar(20) comment '카테고리',
	title text comment '제목',
	date datetime comment '작성 날짜',
	content text comment '내용',
	
	PRIMARY KEY (id)
);

 

사람마다 코딩방법이 다른 것처럼 sql문 작성방법도 미묘하게 차이가 있다고 생각한다. 

나 같은 경우엔 인덱스명, 자료명 , 코멘트, AI, not null 의 순서로 적는다. 

간혹 코멘트를 가장 뒤에 적으시는 분들도 있는데, 그건 본인의 자유라고 생각한다.