Написание правильного описания таблицы

Question

Я впервые пишу описания для своих таблиц SQL Server (из поля Description в окне Properties), и я начал думать о том, что именно писать в таком поле.

Например, некоторые таблицы говорят сами за себя в соответствии со своими названиями ... как таблица под названием Albums в «Музыкальной системе». Какое описание вы бы действительно написали в таком случае?

А какую «другую» информацию вы обычно включаете в описание? Вы упоминаете отношения к столу?

Существует ли стандартный, формальный способ написания описаний для таблиц?

Answer 1

Я считаю, что хорошее именование и дизайн объектов плюс, в конечном итоге, инструмент, который визуализирует структуру вашей базы данных (, например, SQL Doc ), намного лучше, чем добавление подробного описания к каждому объекту.

Чем больше вы хотите охватить в описании, тем больше вероятность того, что оно не будет синхронизировано с реальной структурой базы данных. Например. если вы хотите задокументировать отношение, то каждый раз, когда вы его изменяете, вы должны помнить, что нужно также обновлять описания (для всех задействованных объектов?). Это в основном избыточная информация, поскольку она уже записана в схеме. Мы не хотим избыточности в базе данных, не так ли?

Answer 2

3 простых отчета должны быть выполнены для описания таблицы: одна описывает, что содержит таблица, одна описывает начальное состояние данных в таблице (пустые или предварительно заполненные), а другая описывает, как данные перемещаются в таблицу или выходят из нее. .

Answer 3

Я бы также включил кардинальность / отношение таблицы к другим важным таблицам. Это может показаться очевидным, но часто это не так. Например, для tblAddresses у вас может быть описание:

" Эта таблица является родительской таблицей для строк сведений об адресе (tblAddressLines), и на нее ссылается (а НЕ является дочерним элементом) таблица сотрудников (tblEmployees). "

Answer 4

Если вы используете контроль исходного кода, я не могу придумать ни одного комментария для размещения здесь, который не будет лучше использоваться в качестве комментария SCC. Я думаю, что это излишне, и я бы не использовал его, если бы в вашей организации не было стандарта.

Answer 5

Я бы поместил название заданий / программ / отчетов, которые используют указанную таблицу, в Описание. Это вряд ли требует постоянного обновления и отвечает на вопрос, почему существует эта таблица? (т.е. чьи это данные?)