Вадим Мадисон из Авито, «Что мы знаем о микросервисах».
Вадим рассказывает в том числе про требования к документации для микросервиса. Они прям всерьёз требуют документацию и без неё не принимают микросервис от разработчиков. Вот что в неё входит:
— Описание сервиса. В двух предложениях, что сервис делает.
— Диаграмма архитектуры.
— Runbook. (Про них я скоро опубликую конспект из книги Seeking SRE)
— FAQ
— Описание API endpoints
— Labels — к какому продукту, функциональности и структурному подразделению относится сервис.
— Владельцы кода.
Конспект здесь: https://github.com/NickVolynkin/highload-2018/blob/master/1.1-microservices.md
Post #175
1.93K