Описание метода

Бизнес-задача

Опишите, какой результат должен выдать метод и к какой конечной цели это ведет

Use cases

В формате диаграммы или таблицы

Диаграмма активности/последовательности

Пошаговая UML-диаграмма

Метаданные

Тело запроса

Тело ответа

Возможные ошибки

Контракт

Файл в формате .proto. Подробнее с форматом можно ознакомиться тут: https://protobuf.dev/programming-guides/proto3/

Фича-флаги

Какой настройки необходимо вынести отдельно, чтобы с их помощью управлять поведением метода? Как меняется поведение метода в зависимости от значения фича-флага?

Журналирование

Какие логи должны записываться (с учетом разных уровней логирования) и какие данные в логах должны маскироваться?

Мониторинг

Какие метрики должны быть созданы для отслеживания “здоровья” функциональности на проме?

Трассировка

Какое поле использовать в качестве идентификатора трассировки, и в какие потоки данных дальше передавать, а в какие не передавать?

Безопасность

Запись событий в журнал аудита, ролевая модель, очистка данных перед использованием, алгоритм шифрования, время жизни токенов

Скачать шаблон: https://docs.google.com/document/d/1WuM1Moqyk65Qv2LwqiAR1sff9FReKBGoyxCdAEI-9So/edit?usp=sharing