Всем привет.
Попал на большой проект. Несколько сервисов, у них есть плагины, есть горизонтальное масштабирование (реплики, баланс), свои утилиты, интеграция с внешними системами. Сложная система развертывания, частично ansible, частично свои скрипты. Базы данных: есть Postgres, есть MongoDB, есть S3. REST, gRPC.
В общем, много всего, как "в ширину", так и "в глубину".
Работаю в проекте уже почти год, успешно выполняю задачи (не по всей системе), но никак не могу охватить всё это целиком. Для этой цели хотелось бы "написать книгу о проекте", такую, чтобы человек со стороны, квалифицированный, но не знакомый с системой, мог относительно быстро в ней разобраться.
Есть, конечно, вики на проекте, но она не покрывает всё, сведения отрывочные, да и написано так, что помочь она может в основном тому, кто уже всё знает, но что-то забыл. Например, заходишь в раздел с каким-то достаточно общим названием — а там несколько скриптов для консоли, и всё.
Вот как бы структурировать это всё в документации? Может быть, есть шаблоны описания архитектуры с разделами и подразделами (ну кроме ГОСТа на информационные системы
![](/Forum/Images/smile.gif)
)?
Или какие-то книги известных авторов с описаниями похожих по сложности систем, из которых можно было позаимствовать оглавление?