<Название сущности>

<Название сущности> — краткое текстовое описание того, что представляет собой данная сущность, какую бизнес-роль она выполняет и в каком контексте используется в системе.

Требования

В этом разделе описываются основные бизнес- и системные требования к сущности: - из каких логических частей или зависимостей состоит сущность; - какие ограничения или правила применяются к сущности; - какие варианты поведения, состояния или конфигурации допустимы; - кто и как управляет сущностью (если применимо).

Требования формулируются в виде утверждений.

Атрибуты

Перечень всех полей сущности, которые хранятся в базе данных.

Формат описания атрибута:

<имя атрибута> — <тип данных> — <описание>

Если атрибут принимает ограниченный набор значений, они перечисляются вложенным списком.

Пример: - status — varchar(50) — текущий статус сущности: - draft — черновик - active — активна - archived — в архиве

Если атрибут является связью: - указывается тип связи (один-к-одному, один-ко-многим, многие-ко-многим); - добавляется ссылка на модель связанной сущности.

Связанные модели

Список сущностей, которые логически или физически связаны с данной сущностью. Для каждой связи указывается: - название связанной сущности; - краткое описание характера связи (например: «один ко многим», «используется для…»); - ссылка на файл описания модели.

Примечания

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

Пример

Хорошим примером является описание сущности курса