Команды, работающие с документацией, получают больше возможностей для распространения контента:
- ИИ-ассистентам нужен доступ к структурированным знаниям,
- пользователи рассчитывают на помощь прямо в используемых инструментах и интерфейсах, без перехода в портал документации,
- а управление несколькими вариантами публикаций усложняется по мере роста продуктовых линеек.
Январское обновление Документерры решает эти задачи с помощью независимой настройки ИИ Помощника для внешних сайтов, экспорта в Markdown, ориентированного на ИИ-процессы, и улучшений в управлении проектами с несколькими публикациями.
ИИ Помощник для внешних сайтов: независимая настройка для портала и внешних размещений
Нашего AI-бота – ИИ Помощника, теперь можно использовать не только внутри портала документации. Во время бета-тестирования некоторые клиенты встраивали виджет в свои сайты и продукты. На основе их отзывов мы увидели, что размещение виджета вне портала документации часто требует другого внешнего вида и поведения.
Например, SaaS-компания может встроить ИИ Помощника в контекстную панель помощи в приложении с короткими ответами, адаптированными под рабочие сценарии, в то время как общедоступный портал документации дает подробные технические пояснения.
B2B-вендор может настроить профессиональный, соответствующий бренду виджет на маркетинговом сайте для ответов на вопросы потенциальных клиентов, при этом для технической документации использовать другую терминологию и инструкции для виджета.
Чтобы поддержать такие сценарии, мы разделили настройки на два независимых раздела:
- Виджет портала — управляет поведением ИИ Помощника внутри вашего портала Документерры
- Внешний виджет — управляет ИИ Помощником при встраивании во внешние сайты, приложения или маркетинговые страницы
Каждый раздел имеет собственные настройки:
- Включение/отключение. Настройки можно задать заранее, не запуская виджет для пользователей
- Кастомные подсказки. Разные термины, стили ответов и инструкции в соответствии с контекстом
- Основной цвет. Отдельный акцентный цвет для каждого виджета в соответствии с бренд-гайдами
- Приветственные сообщения и временные тексты. Персонализированный опыт для каждой аудитории
Раздел Внешний Виджет также имеет копируемый HTML-фрагмент для встраивания ИИ Помощника на ваши сайты, с инструкциями для команды разработки.
Полезно, если вы:
- Добавляете контекстную помощь по документации в интерфейс продукта или внутренние инструменты
- Нуждаетесь в разном поведении ИИ Помощника на маркетинговых страницах и в технической документации
- Хотите отдельно отслеживать использование внешнего виджета и виджета портала
- Активируете виджет для внешних размещений, не включая его в портале
Экспорт в Markdown
По мере того как AI-инструменты становятся основой рабочих процессов с документацией, командам требуется передавать контент в LLM — для чат-ботов, AI-агентов, контекстного поиска и кастомных автоматизаций. Для этого отлично подходит Markdown: AI-инструменты корректно обрабатывают такой формат, а люди могут читать и редактировать файлы без специализированных инструментов.
Теперь вы можете экспортировать проекты в формате Markdown через UI или API Документерры. Экспорт включает:
- Страницы в виде .md-файлов
- Изображения и файлы из хранилища
- Структуру дерева страниц в виде YAML-файла
Дерево страниц в YAML адаптировано для обработки LLM, при этом оно остаётся читаемым в обычных Markdown-редакторах, таких как Obsidian или VS Code.
Экспорт через API открывает возможности для интеграции с CI/CD. Например, вы можете настроить пайплайн так, чтобы документация автоматически экспортировалась при каждом новом релизе, обновляя базу знаний чат-бота или синхронизируя контент с вашей LLM-поддержкой.
Используйте экспорт в Markdown, чтобы:
- Передавать контекст документации в LLM для чат-ботов, агентов или кастомных AI-инструментов
- Архивировать проекты в универсальном формате без привязки к вендору
- Обрабатывать контент с помощью собственных скриптов или инструментов анализа
- Автоматизировать доставку документации во внешние системы
Экспорт поддерживает стандартные элементы Markdown: списки, таблицы, встроенное форматирование, примеры кода и изображения с относительными путями.
Улучшения публикации
Сохранение настроек при обновлении
Проекты с несколькими публикациями обычно рассчитаны на разные аудитории, версии продукта или тарифные планы. Например, компания может публиковать отдельную документацию для разных версий изданий с разными иконками и настройками видимости. В API-документации могут существовать отдельные публикации для разных версий API с собственными правилами доступа.
Теперь при обновлении контента можно сохранять настройки конкретной публикации. Достаточно включить эту опцию в мастере обновлений — и персонализированные иконки, параметры видимости и другие настройки останутся без изменений.
Полезно для проектов, где:
- Разные публикации ориентированы на разные сегменты клиентов или группы пользователей
- Каждая публикация имеет собственный брендинг или требования к доступу
- Вы поддерживаете несколько версий продукта или редакций документации в рамках одного проекта
Видимость условных тегов
Продолжая улучшения для проектов с несколькими публикациями, а также следуя запросам клиентов, мы добавили отображение условных тегов на странице Проекты.
Теперь при публикации контента, который имеет условия и условные теги, эти теги отображаются рядом с каждой публикацией. Это позволяет:
- Сразу понимать, какие варианты контента опубликованы
- Различать публикации с похожими названиями
- Проводить аудит условного контента без открытия настроек публикации
Это особенно полезно для проектов, которые поддерживают несколько версий продукта или вариантов документации для разных аудиторий.
Кнопка Свернуть/Развернуть для ИИ Помощника
Некоторые пользователи активно взаимодействуют с ИИ Помощником, особенно при разборе сложных проблем или подробном изучении рабочих сценариев. Такие диалоги могут включать длинные ответы с примерами кода, пошаговыми инструкциями и многоступенчатыми объяснениями.
Теперь виджет можно развернуть, чтобы увеличить область чтения, а затем вернуться к обычному размеру.
Готовы попробовать?
Настройки внешнего виджета, экспорт в Markdown и улучшения управления публикациями уже доступны в январском обновлении. Пользователи пробной версии могут начать тестирование экспорта и сценариев с несколькими публикациями уже сегодня, а существующие клиенты получат доступ в рамках общего релиза в ближайшие недели.
Нужна помощь с изучением новых возможностей? Забронируйте демо с нашей командой!
