DATABASE2009/05/03 20:52

최근 사내 테이블 명세서 문서화를 하기위해 구축한 시스템이다.

테이블, 칼럼값 정의, ERD에 대한 문서화가 요구되었고 개인적으로 앞의 모든 문서들을 검색 등을 이용해 쉽게 찾을 수 있고 문서의 변경 이력 등을 자동으로 관리할 수 있기를 원했다.

검색과 변경 이력 추적을 위한 솔루션은 MS의 쉐어포인트 포탈과 같은 MS 오피스 협업툴과 웹 기반의 CMS, WiKi등의 툴이 있다. 

쉐어포인트 포탈의 경우 기존 문서화에 사용되는 MS 오피스 포멧을 바로 사용할 수 있다는 장점이 있지만 ERD 드로잉 툴인 Visio의 라이선스 문제 등으로 인해 대상에서 제외하기로 하였다.

무료 ERD 드로잉 툴을 알아보던 중 GraphViz라는 무료 드로잉 툴이 MediaWiki에 확장기능으로 제공됨을 파악하고 문서화 솔루션을 MediaWiKi + GraphViz Extension 으로 하기로 결정하였다.

테이블명세, 칼럼값 정의명세를 위한 틀을 작성하여 명세서들의 기본 포멧을 결정하고 틀 내에 주석을 통해 작성방법을 설명하고 있다.

분류를 통해 각 명세 페이지들을 쉽게 찾아볼 수 있도록 했다.

ERD 생성을 위해 WiKi서버에 GraphViz 를 설치하고 MediaWiki의 GraphViz Extension을 설치한다.

Windows에 설치하는 경우 GraphVizAndMSCGen Extension을 설치해야 정상적으로 작동한다.

ERD의 경우 크로우즈 핏 노테이션을 사용하는데 그 표현은 dot 문법의 Arrow Shape 중 tee와 crow, odot을 이용하여 다음과 같이 표현한다.

crowodot

crowtee

teetee

teeodot

크리에이티브 커먼즈 라이선스
Creative Commons License

'DATABASE' 카테고리의 다른 글

SQL 2K sysindexes Table  (0) 2009/05/16
MSSQL에서 사용자와 로그인 매핑 방법  (0) 2009/05/14
테이블 명세 문서화  (0) 2009/05/03
FILLFACTOR 와 PAD_INDEX  (0) 2009/03/31
Page Split이 Latch를 유발할 수 있다.  (0) 2009/03/31
특정 조건의 SP 찾는 쿼리  (0) 2009/01/19
Posted by 후후쇼