Документирование процессов/взаимодействий
В описание процессов попадают взаимодействия моделей, происходящие в несколько этапов или разнесенные по времени, например прохождение тестирования:
- в начале необходимо получить модель теста, по ней создать прохождение теста (модель, которая хранит результаты прохождения теста конкретным пользователем) и связать с пользователем
- у прохождения теста поставить время начала теста и записывать ответы пользователя
- по окончании тестирования нужно подвести итог, пометить прохождение теста как завершенное
Пример выше весьма упрощен, но и так видно, что в рамках одной модели не описать все взаимодействия.
Правила оформления
- Название процесса в качестве главного заголовка первой строкой в файле, например
# Синхронизация данных между Dispace и ЦИУ
. - Текстовый блок с кратким описанием сути процесса и его результатов.
- Блок моделей, участвующих в процессе, начинается с заголовка
## Модели
. Содержит список моделей со ссылками на их файлы - Блок описания процесса, начинается с заголовка
## Процесс
- само содержание блока может варьироваться, от списка последовательных шагов до дерева возможных сценариев в виде диаграммы главное - наглядность и краткость