Перейти к основному содержимому

Новая документация Conversational Cloud

Команда Just AI представляет новую пользовательскую документацию Conversational Cloud.

Этот портал объединяет в себе документации JAICP, Aimylogic, Aimyvoice и Aimychat, которые ранее существовали отдельно. Также он предлагает новые возможности, благодаря которым вы можете получать нужную информацию эффективнее:

  • Быстрая навигация по сайту.
  • Расширенные возможности поиска и фильтрации статей.
  • Переключение между светлой и темной темой.

Причины переезда

Conversational Cloud — облачная среда для проектирования, разработки, развертывания и поддержки Conversational AI-решений. В настоящее время в нее входит целый ряд продуктов:

Подробнее об истории развития Conversational Cloud

Понятие Conversational Cloud появилось значительно позже, чем зародился продуктовый стек Just AI. Долгое время развитие компании было сосредоточено вокруг двух основных продуктов: JAICP и Aimylogic. Оба продукта заточены на разработку диалоговых решений, но занимают свои специфические ниши, имеют разный порог входа и целевую аудиторию.

В конце 2018 года мы запустили публичную документацию к JAICP — самому сложному из наших продуктов, каковым он остается и по сегодняшний день. Мы разместили ее по адресу help.just-ai.com — это доменное имя осталось с тех времен, когда мы полагали, что других подобных ресурсов компании не потребуется. Однако совсем вскоре Aimylogic также перешагнул тот порог, когда без публичной базы знаний еще можно обойтись, и поэтому уже в следующем году обзавелся собственной документацией со своим интерфейсом.

Приоритеты компании между тем тоже не стояли на месте: в 2021 году запустился новый продукт Aimyvoice — платформа для синтеза живых голосов. К середине 2022 года нашел воплощение и сам Conversational Cloud, а три упомянутых продукта были объединены между собой при помощи технологии единого входа (SSO): если у вас был аккаунт в одном из продуктов, теперь вы могли бесшовно переключиться на любой другой. Еще через какое-то время был запущен и встроен в эту среду наш операторский чат Aimychat.

Запуск каждого из этих продуктов сопровождался запуском отдельного сайта со своей документацией. Однако в какой-то момент стало очевидно, что такой подход плохо масштабируется как для авторов, так и для читателей. Знания о продуктах оставались разрозненными, форма их подачи слабо стимулировала систематизацию — в то время как степень интеграции самих продуктов между собой, напротив, только росла.

  • Например, в телефонных ботах JAICP появилась возможность использовать синтез речи от Aimyvoice, а в Aimylogic — переключаться на разработку сценария через графический редактор J‑Graph. Чтобы подробнее узнать об этих возможностях, приходилось переходить в документацию другого продукта.
  • JAICP и Aimylogic имеют много общей функциональности: HTTP API, такие как Chat и Calls API; базу знаний, аналитику по проектам. При написании соответствующих разделов документации их приходилось частично или полностью дублировать, что осложняло дальнейшую поддержку.

Что изменилось

Мы объединили документации по всем продуктам Conversational Cloud на этом сайте. Теперь вы можете легко находить необходимую информацию и узнавать об обновлениях во всех продуктах.

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

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

За долгое время это первая попытка пересмотреть наш подход к документации, и в ней по-прежнему есть большое пространство для улучшений. Мы планируем развивать этот проект и продолжить процесс упорядочивания и систематизации знаний о наших продуктах.

Если вы хотите поделиться с нами пожеланиями или предложениями по развитию этого сайта, вы всегда можете связаться с нами в сообществах JAICP и Aimylogic либо через техническую поддержку.