Analyst Days 17 — Иван Поддубный, Docs-as-Code на пальцах
Инженерный подход при создании документации имеет достаточно широкий пласт последователей. Рассмотреть такие системы можно по многим причинам, и вот лишь некоторые из них: вы доросли до ревью требований; вы понимаете значимость удобства редакторов кода; вам нужна open source self hosted система или мало денег; вы сидели на google docs и хотите получить инструмент следующего уровня; вам нужна отчуждаемая система документации; вы хотите автоматизировать пайплайн качества документации с помощью стат-анализа, уменьшив объем ручного труда. Мы рассмотрим: Принципы работы: в каком случае подход будет оправдан, а когда нет. Классификацию и основные инструменты, в т.ч. инструмент от Facebook в сочетании с различными редакторами. Преимущества, которые дает docs-as-code подход, в т.ч. ревью, запросы на изменение, статические анализаторы качества документации. Мы успешно используем и внедряем docs-as-code подход на многие проекты в заказной разработке для крупных корпораций.
Инженерный подход при создании документации имеет достаточно широкий пласт последователей. Рассмотреть такие системы можно по многим причинам, и вот лишь некоторые из них: вы доросли до ревью требований; вы понимаете значимость удобства редакторов кода; вам нужна open source self hosted система или мало денег; вы сидели на google docs и хотите получить инструмент следующего уровня; вам нужна отчуждаемая система документации; вы хотите автоматизировать пайплайн качества документации с помощью стат-анализа, уменьшив объем ручного труда. Мы рассмотрим: Принципы работы: в каком случае подход будет оправдан, а когда нет. Классификацию и основные инструменты, в т.ч. инструмент от Facebook в сочетании с различными редакторами. Преимущества, которые дает docs-as-code подход, в т.ч. ревью, запросы на изменение, статические анализаторы качества документации. Мы успешно используем и внедряем docs-as-code подход на многие проекты в заказной разработке для крупных корпораций.