В современных командах разработки программного обеспечения автоматизация процессов играет ключевую роль. Среди этих процессов важное место занимает подготовка релизных заметок (Release Notes) ⎼ документации, описывающей изменения, исправления и новые возможности, внедренные в новой версии приложения или сервиса. Автоматизация этого процесса позволяет сэкономить время и упростить коммуникацию как внутри команды, так и с конечными пользователями.
Интерфейсный дизайн
Для автоматизации подготовки Release Notes вам понадобится интерфейс, удобный для ввода информации и генерации документации. Рекомендуется использовать инструменты, позволяющие также автоматически создавать версии документов, а также отслеживать изменения и комментарии к ним.
Автоматизация процесса
Для автоматизации процесса подготовки Release Notes можно использовать средства разработки и современные технологии, такие как скрипты командной строки, утилиты для управления системой, командные инструменты для работы с данными и т.д.
В качестве примера, можно использовать Windows CMD команды для автоматической выгрузки списка изменений из системы управления версиями, дополнив этот список командами для извлечения информации из инструментов обратной связи с пользователями (например, из системы учета обращений пользователей).
Веб-разработка
Автоматизация генерации
Важной частью автоматизации процесса подготовки Release Notes является генерация документации на основе введенных данных. В этом случае могут помочь различные технологии и инструменты, такие как шаблонизаторы (например, Handlebars.js), которые позволяют создавать шаблоны документов и заполнять их данными автоматически.
Документация изменений
Другим важным аспектом автоматизации процесса создания Release Notes является автоматическое отслеживание изменений, вносимых в код или другие ресурсы проекта. Для этого могут быть использованы инструменты контроля версий (например, Git) для отслеживания изменений в коде и автоматической генерации информации об этих изменениях.
Автоматизация подготовки Release Notes в современной команде разработки играет важную роль, помогая ускорить и упростить процесс, а также улучшить качество коммуникации внутри команды и с конечными пользователями. Использование современных инструментов и технологий, таких как команды командной строки, веб-разработка, автоматизация генерации и документации изменений, позволяет значительно повысить эффективность процесса создания Release Notes.
Автоматизация подготовки примечаний к выпуску в сегодняшней команде разработчиков
Делясь своим опытом того, как в True Engineering мы составляли примечания к выпуску — быстро, правильно и без ручной работы.
Мы начали автоматизировать подготовку примечаний к выпуску. Наша цель состояла в том, чтобы стандартизировать их для всех команд, уменьшить объем ручной работы руководителей групп и менеджеров по менеджменту и убедиться, что мы не вводим потенциальных ловушек, которые могут возникнуть, когда мы делаем что-то вручную. <рисунок> .
На нашем внутреннем портале мы создали веб-конструктор, который упрощает отправку предварительного отчета всего несколькими щелчками мыши. Сервис интегрирован с трекерами задач, откуда автоматически скачивает всю информацию о выпусках. При выходе приложение генерирует красиво отформатированный отчет по электронной почте для клиента. Вся информация разбита на категории, каждый элемент имеет ссылку на соответствующую страницу в трекере.
Почему были внесены изменения
Инструмент работает таким образом уже несколько лет, но прогресс продолжается. Когда мы начали внедрять разработку на основе магистрали (TBD), нам также пришлось изменить наш подход к примечаниям к выпуску.
Структура TBD предполагает, что разработка продолжается, и команда постоянно выпускает обновления микро-релизов. Это ускоряет разработку продукта, сокращает время выхода на рынок (время от начала разработки до доставки продукта клиенту) и обеспечивает разработчикам немедленную обратную связь от клиентов и пользователей.
Еще одним фактором является то, что в последние годы большинство продуктов True Engineering перешло на микросервисы. Эта архитектура означает, что у команд есть несколько репозиториев для каждого участвующего микросервиса. Один выпуск функциональности включает несколько выпусков для разных микросервисов, и отслеживать это довольно сложно.
Новая механика
Мы переосмыслили примечания к выпуску, полагаясь на автоматизированный PBI (элемент невыполненной работы продукта, который в терминологии TFS является всей задачей). Мы уже запускали задачи автоматической пометки раньше, чтобы инженеры QA могли видеть, какие функции могут быть отправлены на тестирование. Теперь мы используем ту же разметку для примечаний к выпуску.
Специально созданный плагин TFS на основе TFS Aggregator ежедневно просматривает заполненные PBI и генерирует сводное письмо для менеджеров, директоров, отдела продаж. Агрегатор позволяет автоматизировать многие ручные операции при работе с PBI — например, отслеживать, когда последняя задача в PBI становится выполненной, и отмечать весь PBI как завершенный. Агрегатор имеет очень гибкий способ работы с базой правил — разделяя их по проектам, типам задач и т. Д. В целом, он отлично справляется с рутинной работой, которая отнимает у команды много времени и усилий.
Вот как примечания к выпуску работают автоматически. Решение уже опробовано в двух наших проектах, и вскоре новые механики будут внедрены во всех командах True Engineering. Прелесть этого решения в том, что масштабировать этот опыт будет очень просто — просто отправьте электронное письмо в службу поддержки с тегом, который должен улавливать Aggregator, и списком мест, куда следует отправлять примечания к выпуску.
