https://infostart.ru/upload/iblock/a06/a06ba302ba5d5cbded6b72bd5771f9b7.png

Тема с документацией всегда вызывает дискуссию. Окей, вбросил.
Логично, раз сказал А, то и надо говорить Б. Иначе я буду тем же индусом, которому явно что-то надо оторвать.

Я задался вопросом лет 5 назад, как описать автоматизацию. Думая над стандартными блок схемами, я решил обратиться в бизнес анализ и их аннотации. И в принципе я нашел. IDEF0 позволяет просто описать процесс автоматизации. Поэкспериментируйте. Будет интересно.

В итоге, за годы в тимлидстве я свел документацию по девопсу до трех основных типов документов.
Первый тип - описание автоматизации. IDEF0 - велком. Просто, можно декомпозировать до многих документов, легко и гибко. Картинка пример.

Второй тип - архитектурная схема автоматизации, и архитектурная схема инфраструктуры. Благодаря экспериментам известно, что удобная схема представляет себя группировки серверов и сетей поверх этих групп. Связи помогают на схеме понять всем (включая ИБшников), куда смотреть.Рисует тимлид.

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

Но, это все “Советы Сары Львовны”. Однако, сказки про изменчивость мира девопса - это сказки) Если девопс закладывает в автоматизацию сам факт того, что она через год изменится - значит это хреновый девопс :)