Автоматизация документации в Medusa: как AI меняет внутренние процессы

В компании Medusa мы активно внедряем автоматизацию внутренних операций с помощью искусственного интеллекта, что позволяет нам повысить эффективность работы. Это касается различных областей, включая инженерные процессы, документацию, продажи и другие операции. Благодаря этому мы можем сосредоточить наши ресурсы на более инновационных задачах и быстрее предоставлять новые функции нашим пользователям. В этой статье мы начинаем серию публикаций о различных автоматизациях, которые мы разработали за последний год, и делимся тем, как они работают и чему мы научились в процессе.

Проблема: Поддержка актуальности документации в AI Toolkit

Несколько месяцев назад мы делились постом о нашей системе самообновляющейся документации. Одной из главных проблем работы с документацией является необходимость поддерживать её актуальность в условиях быстрого роста продуктов, особенно когда они размещены в разных рабочих пространствах или репозиториях. Эта проблема также касается агентских ресурсов и инструментов, таких как навыки и инструкции на серверах MCP. Наш AI Toolkit помогает агентам создавать сложные настройки электронной коммерции, проектировать витрины, следуя лучшим практикам пользовательского опыта, и управлять развертываниями на Medusa Cloud. Однако, поскольку эти инструменты распределены по проектам, поддерживать их в актуальном состоянии становится еще сложнее, но не менее важным.

Обзор AI Toolkit

Прежде чем углубиться в то, как мы реализовали агентскую автоматизацию для обеспечения синхронизации нашей документации в AI Toolkit, давайте сначала рассмотрим, что включает в себя этот набор инструментов:

Навыки разработки Medusa: Эти навыки можно установить с помощью skills.sh или как плагин Claude Code. Они содержат информацию о конвенциях Medusa, о том, как создавать настройки в Medusa, как добавлять виджеты в админку и многое другое.

Документы MCP Server: Этот сервер MCP включает в себя различные инструменты, которые предоставляют агентам инструкции, похожие на документацию, такие как:

- Подсказки по миграции с Shopify, WooCommerce и Magento на Medusa, включая шаги и информацию, связанную с моделями данных Medusa. - Подсказки по интеграции с провайдерами платежей и выполнения заказов, включая шаги по реализации провайдера с указаниями для различных типов провайдеров. - Подсказки по расширению продукта, которые включают инструкции по созданию настроек, связанных с моделью данных продукта, например, добавление бренда или ссылки на поставщика на рынке.

Навыки лучших практик для витрины электронной коммерции: Навык и плагин Claude Code с знаниями и лучшими практиками UX для создания витрины электронной коммерции, включая создание общих элементов интерфейса и подключение к платформам электронной коммерции, аналогичным Medusa.

Навыки Medusa Cloud CLI: Навык и плагин Claude Code, который помогает агентам использовать Medusa Cloud CLI для управления и отладки развертываний.

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

Существующая автоматизация документации

В начале этого года мы разработали систему автоматизации, чтобы обеспечить актуальность нашей документации. Эта система отслеживала изменения в Medusa open source и Medusa Cloud и открывала pull request для обновления документации. Она работала через GitHub Actions, которые запускали Claude Code для перевода изменений в коде в изменения в документации. После публикации блога о актуальных документах с агентской автоматизацией мы расширили поток автоматизации, добавив автоматизацию для других инструментов, включая справочник Medusa Cloud CLI, справочник вебхуков Medusa Cloud и автоматизацию релизов как для Medusa open source, так и для Medusa Cloud. Все эти действия приводят к открытию PR для обновления документации.

Расширение автоматизации документации на AI Toolkit

С помощью вышеописанной автоматизации документации, документация становится надежным источником информации для всех продуктов Medusa и остается актуальной по мере выпуска новых функций. Чтобы гарантировать, что информация в нашем AI Toolkit также остается актуальной, мы добавили новый набор автоматизации для каждого инструмента, который отслеживает изменения в документации. Каждый раз, когда мы обновляем документацию, это запускает автоматизацию в наших репозиториях, содержащих навыки Medusa и документы MCP, с указанием того, что изменилось. Затем Claude Code открывает PR для каждого из этих инструментов с необходимыми обновлениями. Например, когда мы обновили react-router-dom в недавнем релизе, что привело к обновлению его API, это вызвало PR в репозитории medusa-agent-skills для обновления используемого там API. Затем наша команда проверяет эти PR и включает их. AI Toolkit, вместе с документацией, остается надежным источником информации как для агентов, так и для людей. Мы больше не тратим время на ручной поиск этих несоответствий и их исправление, или на то, чтобы подвергать наших пользователей разочарованию, пока мы не найдем устаревшую информацию. Вместо этого наше время уходит на улучшение как разработческого, так и агентского опыта.

Просмотр потока автоматизации

Большая часть нашего потока автоматизации находится в инструменте docs-automator в нашем открытом репозитории. Он формирует входные данные из различных источников в подсказки Claude Code, которые используются для внесения изменений в документацию. Когда PR документации объединяются, действие notify-docs-consumers GitHub запускает автоматизацию в других репозиториях, таких как автоматизация в medusa-agent-skills. Эти действия, в свою очередь, открывают PR в своих репозиториях для обновления их с изменениями в документации.

Начните работать с Medusa

Если вы новичок в Medusa, ознакомьтесь с документацией, где вы получите более глубокое понимание того, что такое Medusa, какие функции электронной коммерции она предоставляет и как развернуть Medusa в облаке.