В ноябре 2022 года прошла конференция, предназначенная для аналитиков FlowConv 2022. Особенностью конференции являлось ориентирование на конкретные практические рецепты. В этой статье мы разберём один из таких рецептов, а именно Docs As Code (DocOps).
На конференции рассказали о практике хранения документации на примере Тинькофф и ЮMoney. Оба примера доказывают, что такой подход улучшил взаимодействие аналитиков и разработчиков, и документация на все 100% теперь совпадает с текущим состоянием информационного продукта.
Один из примеров на конференции от спикеров показал, что методология DocOps позволяет получить документы именно того формата, который соответствует требованиям заказчика. Это происходит, потому что работа в данной методологии сконцентрирована на содержании процесса документирования, а не на его формате.
Дискуссия, в которой приняло участие более 80 людей, позволила обозначить ряд проблем и способы возможного их решения. Технологии, которые могут помочь преодолеть большинство из проблем в этой сфере:
• Sphinx-needs. Эта технология позволяет автоматизировать и настраивать большое количество задач в соответствии с внутренними процессами и руководящими принципами.
• Gherkin. Это язык описания желаемого поведения системы. Проще говоря, он предназначен для того, чтобы людям было легче понимать информацию, но при этом соблюдалась формальность и возможность автоматической обработки.
• Jetbrains MPS. Технология, которая позволяет создавать свой собственный язык, специфичный для конкретной предметной области, с полной средой разработки.
• DocHub. Это специальный онлайн-сервис, который позволяет работать с PDF-форматом, редактировать сразу документ, ставить подписи и создавать новые документе, основываясь на готовые шаблоны.
Все вышеперечисленные технологии, безусловно, имеют ряд некоторых недостатков и ограничений, из-за которых нельзя решить абсолютно все проблемы за короткий промежуток времени. Подход DocOps объединяет в себе процессы документирования, разработки и доставки IT-продукта, что как раз и позволяет эффективно выбрать те технологии, которые способны решить многие проблемы. Технологии документирования развиваются очень быстро, при этом пользоваться всеми этими технологиями не очень тяжело, и обучиться этому под силу каждому, у кого есть желание. Если перед аналитиками и разработчиками стоит огромное количество проблем, связанных с документацией, то подход Docs as Code поможет найти эффективное решение практической для каждой проблемы.