Документирование моделей
Под моделью понимается абстрактное представление реального объекта с минимально необходимым набором атрибутов для решения поставленных задач. Студент может быть моделью, синхронизация данных между Dispace с ЦИУ не может, так как это процесс.
Правила оформления
- Название модели в качестве главного заголовка первой строкой в файле, например
# Название модели. - Текстовый блок с кратким описанием реального объекта. В описании раскрывается что именно нас интересует. Например, студент в реальности это многоплановый объект, но для организации документооборота, сопровождающего обучение, нам могут быть интересны только ФИО и номер группы. В разных проектах могут быть модели с одинаковым названием, но в разном контексте - описание должно раскрывать разницу между ними.
- Блок атрибутов, начинается с заголовка
## Атрибуты. Содержит список из элементов, содержащих: - название на английском языке (то название, которое будет использоваться/используется в коде)
- тип данных используемый в коде (с возможными ограничениями, например по длине строки)
- описание атрибута. Если это ссылка на другую модель - в описании должна присутствовать ссылка на файл модели в документации
- Блок табличного представления, начинается с заголовка
## Табличное представление- код, с помощью которого можно создать таблицу в базе данных для этой модели
Пример модели
# Группа
Организация студентов в группы. Содержит информацию о дате начала обучения, рабочем плане, списке обучающихся.
## Атрибуты
- id - bigint - уникальный ID группы
- title - varchar(255) - документальное название группы, например "ФЛ-120"
- description - text - описание группы
- year - int - год набора (полный год, например 2021)
- status - int (default 0) - статус группы:
- 1 - учится
- 2 - закончила обучение(удаленная)
- id_ciu - bigint - id в базе ЦИУ
- faculty_id - bigint - [Факультет](%путь_до_файла_модели%)
## Табличное представление
Некоторое табличное представление