Официальным стандартом является ИСО / МЭК 11179 ... который причиняет вам боль и ссылается на семантические элементы документированной модели данных, когда нам обычно нужны как семантические, так и физические (таблицы, поля и т. Д. .) документация в словаре данных реального мира.
Лично я предпочитаю (как бы вы ни реализовывали это на ваше усмотрение) физические и опционально логические модели Entity-Relationship на первой странице, экране ввода или там, где пользователь словаря данных впервые «нажимает» (Это обеспечивает мета слой до детали ниже).
Тогда для каждой таблицы:
Имя таблицы [Физический | Логическое]
Описание таблицы (содержание, детализация, «периодичность» (если есть)
один, период времени, который применяется к данным, содержащимся в таблице),
источник)
Тогда для каждого столбца:
Имя столбца
Описание столбца
Тип столбца
Размер столбца в байтах
[Необязательно] Другие подробности столбца ... обнуляемый, триггеры, источник
Отношения Имя ограничения | «Другое» Таблица | Кардинальность | Тип
и т.д.
Индексы Имя | колонка
Членство | Тип и т. Д.
... Очевидно, это подход «меньше - больше» для определения словаря данных! Я думаю, что ключом является предоставление простого способа (через ER) модели, а не просто длинный, трудоемкий список таблиц и столбцов.