저는 처음으로 (창에있는 Description 필드의) SQL Server 테이블에 대한 설명을 쓰고 있는데, 그런 필드에 정확히 무엇을 써야하는지 생각하기 시작했습니다.적절한 테이블 설명 작성
예를 들어, 일부 테이블은 "음악 시스템"에 Albums이라는 테이블과 같이 제목에 따라 자명합니다. 그러한 경우 실제로 어떤 기술을 쓸 것입니까?
그리고 '기타'정보는 일반적으로 설명에 포함되어 있습니까? 테이블과의 관계에 대해 언급 해 주시겠습니까?
표에 대한 설명을 작성하기위한 표준적이고 공식적인 방법이 있습니까?
나는 훌륭한 객체 명명과 디자인 플러스 결국 데이터베이스 구조 (e.g. SQL Doc)를 시각화하는 도구가 각 객체에 대한 자세한 설명을 추가하는 것이 훨씬 낫다고 믿습니다.
설명에 더 많이 표시하고 싶을수록 실제 데이터베이스 구조에서 동기화되지 않을 가능성이 커집니다. 예 : 관계를 문서화하려면 변경 할 때마다 설명을 업데이트해야한다는 사실을 기억해야합니다 (관련된 모든 객체에서)? 기본적으로 스키마에 기록되어 있기 때문에 기본적으로 중복 정보입니다. 우리는 중복성을 원하지 않습니다.
설명에 해당 테이블을 사용하는 jobs/programs/reports의 이름을 넣었습니다. 이것은 상시 업데이트가 필요하지 않을 수 있으며 왜이 테이블이 존재 하는가에 대한 질문에 대답합니다. (즉, 데이터의 대상은 누구입니까?)
다른 중요한 테이블에도 테이블의 카디널리티/관계가 포함됩니다. 이것은 명백하게 보일지도 모르지만 종종 그렇지 않습니다. tblAddresses에 대한 예를 들어 당신이 설명이있을 수 있습니다
을 "이 테이블 주소 상세 선 (tblAddressLines)의 부모 테이블과 (와 NOT 아이) Employees 테이블 (tblEmployees)에 의해 참조되는."
소스 코드 컨트롤을 사용하는 경우 SCC 주석으로 더 잘 사용되지 않는 주석을 여기에 넣을 수는 없습니다. 나는 그것이 불필요하다고 생각하며 조직에 표준이 없다면 사용하지 않을 것입니다.
3 간단한 설명이 테이블 설명에 대해 수행해야합니다. 하나는 테이블의 내용을 설명하고, 하나는 테이블의 초기 데이터 상태를 설명하는 것으로 (비어 있거나 사전에 채워짐), 하나는 데이터가 내부/외부로 어떻게 이동하는지 설명하는 것입니다. 표.