Описание компонентов ​

Описание компонента предполагает краткое объяснение, описывающее ваш микросервис в терминах «О чем компонент?» и «Какова цель его использования?». Предполагается, что это описание того, какие общие сценарии использования решают микросервис и какую область данных он обрабатывает. В общем, это не должно превышать 30-50 строк текста, потому что это микросервис, а не типичное монолитное приложение. Описание должно быть достаточно четким, чтобы предоставить всем разработчикам и архитекторам информацию, которая может им понадобиться для принятия решения — какие варианты использования целесообразно добавить в этот микросервис. Если по какой-либо причине в микросервис будет добавлен какой-то новый функционал, его описание необходимо расширить.

Описание вариантов использования ​

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

Инструкция по использованию, сборке и развертыванию ​

Этот раздел служит источником информации о том, как настроить, собрать и развернуть компонент. Самая важная часть — это описание всех файлов конфигурации и основных параметров конфигурации. Предлагается иметь здесь единый список всех жизненно важных файлов конфигурации. Если ваш код полагается на другое приложение или библиотеку, обязательно укажите эти зависимости здесь. Этот раздел хорошее место для раздела часто задаваемых вопросов, который можно использовать для хранения полезных советов, которые обычно разработчики задают в чате разработки.

Ссылки на документацию ​

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