Svaya / Документация
Документация Svaya
Этот раздел о том, что умеет платформа, как поставить ее на свои серверы, настроить под свою компанию и поддерживать ее работу. Для каждой работы здесь описаны порядок действий, экраны кабинета и команды на сервере, а также то, что компания делает сама, без БизнесМатики.
Кому этот раздел
Раздел написан для трех разных моментов работы, и обычно все три проходит один и тот же человек.
- До пилота. Вы решаете, потянет ли ваша команда эксплуатацию. Начните со страницы развертывания. По ней видно, сколько шагов в установке платформы и что делаете вы, а что мы.
- Когда собираете первую автоматизацию. Платформа уже стоит, и нужно, чтобы она начала отвечать сотрудникам или вести дело по шагам. Автоматизацию вы собираете сами, из своего кабинета. Две страницы про сборку ведут по этому пути от первого экрана до раздачи рабочих мест.
- Дальше, когда платформа работает. Вы ведете ее на своих серверах. Здесь страницы с процедурами, экранами и сообщениями, которыми платформа отвечает при отказе.
С чего начать
Читать раздел подряд не нужно. Пути ниже собраны под разные вопросы, и внутри каждого пути страницы стоят в том порядке, в котором их проходят.
Хотите понять, что умеет платформа
Начните со страницы «Что умеет платформа». На ней семнадцать функций по порядку, у каждой функции пояснение и ссылки на подробности. Подробности собраны на семи страницах по темам, от обработки запроса и защиты данных до готовых прикладных задач. Развертывание платформы описано в группе «Начало», лицензирование в группе «Настройка», а обновление, резервные копии и наблюдение за состоянием в группе «Эксплуатация».
Вы смотрите платформу до сделки
Вопрос звучит так. Хватит ли у нас серверов и рук, чтобы это держать. Ответ собирается из трех страниц и читается примерно за полчаса. Сначала что нужно от серверов. Потом из чего собрана платформа, чтобы видеть, за чем придется следить. Потом развертывание, где по шагам расписано, что делает ваша сторона и что делаем мы.
Платформа стоит, нужна первая автоматизация
Выбор одной страницы зависит от того, что автоматизация должна уметь. Если она отвечает сотрудникам по вашим документам, идите на сборку ИИ-ассистента. Если она ведет дело по шагам, спрашивает человека на остановках и пишет в ваши системы, идите на сборку ИИ-агента. Обе страницы написаны как инструкция от первого нажатия до выпуска. Справочник видов шагов и их полей нужен рядом со второй, когда дойдете до сборки маршрута.
Платформа работает, нужно вести ее дальше
Тут порядок задает календарь. Экраны кабинета нужны в первый же день, это обход всего интерфейса подряд. Наблюдение за состоянием настраивается один раз и дальше работает само. Обновление и откат читается перед первым переходом на новую версию, резервные копии проверяются до того, как они понадобятся. Диагностику отказов открывают, когда что-то уже пошло не так, и она написана под этот момент.
Что вы делаете сами
Граница проходит по одной линии. Все, что касается ваших процессов, ваших документов и ваших сотрудников, делается из вашего кабинета и без обращения к нам. Все, что касается самой платформы как продукта, делаем мы.
Из кабинета, своими руками, без письма в БизнесМатику, делается вот что.
- Собрать свою автоматизацию. Вы описываете словами, что автоматизация должна делать, выбираете скелет (автоматизацию-образец), заполняете разделы и выпускаете автоматизацию. Действие доступно тому, у кого есть роль «автор автоматизаций».
- Править автоматизацию дальше. Тексты, пороги и подсказки меняются сразу. Изменения, которые трогают шаги и права, проходят через выпуск новой версии, и предыдущая версия остается на месте, пока новая не выпущена.
- Снять автоматизацию с работы. Автоматизация уходит из списков сотрудников, а ее история и записи прогонов остаются на месте и читаются в журнале.
- Раздать рабочие места. Кто из сотрудников видит автоматизацию, кто отвечает за очередь остановок и кто смотрит журнал, решается на экране рабочих мест.
- Подключить свои данные. Выгрузка папкой или подключение к системе, для которой у платформы есть контракт. Список таких систем на странице источников данных.
Силами БизнесМатики делается вот что.
- Выпуск новых версий платформы.
- Первая установка платформы на ваши серверы, если вы поручите ее нам. Ее может сделать и ваш администратор сам: форма поставки открытая, нашего доступа к серверу она не требует.
- Готовые автоматизации, которые приезжают вместе с платформой. Они собраны нами и прошли нашу приемку, и в карточке такой автоматизации стоит пометка о происхождении.
- Подключение к системе, для которой у платформы контракта нет. Это отдельная работа, и она обсуждается отдельно.
- Разбор отказов, которые не закрываются со стороны кабинета.
Если вы читали прежнюю редакцию раздела, обратите внимание. Раньше здесь было написано, что автоматизацию подключает БизнесМатика по вашему письму. Сейчас порядок другой. Автоматизацию вы собираете сами, и весь путь описан на двух страницах про сборку.
Как устроены страницы
Страницы раздела написаны по одним правилам, и знание этих правил экономит время при чтении.
- Два слоя языка. Первый абзац страницы написан обычными словами и читается без подготовки. Ниже по тексту стоят те же слова, что на экранах платформы и в командах, потому что инструкция, называющая вещи иначе, чем интерфейс, перестает быть инструкцией.
- Термин вводится один раз врезкой. Врезка отбита слева чертой и объясняет слово в том значении, в каком его понимает платформа. Дальше по странице слово уже не поясняется.
- Названия экранов и кнопок стоят в кавычках-елочках. Так отличают надпись, которую читатель ищет глазами в интерфейсе, от обычного слова в прозе.
- Снимки экранов собраны из кода. Они пересобираются одной командой вместе со сборкой интерфейса и поэтому не расходятся с ним молча.
- Дата редакции стоит вверху каждой страницы. По ней видно, насколько свежий текст вы читаете.
- Оглавление справа ведет по заголовкам этой страницы, а меню слева по всему разделу. Внизу каждой страницы стоит переход к соседней в том же порядке, в каком идут пункты меню.
Если текст страницы разошелся с тем, что вы видите на экране, это дефект раздела. Напишите в поддержку и укажите адрес страницы, так правка дойдет быстрее всего.
Карта раздела
Двадцать семь страниц в семи группах, не считая этой. Группы идут от начала работы и возможностей платформы к сборке автоматизаций, настройке и эксплуатации, а в конце стоят группы «Данные и безопасность» и «Справка».
Начало
Возможности
Как собрать автоматизацию
Настройка
Эксплуатация
Данные и безопасность
Справка
Как устроена платформа целиком, разобрано на странице устройства платформы.
Чего здесь нет
Раздел описывает платформу вообще, без подробностей именно вашей платформы. Поэтому здесь не публикуется следующее.
- Внутренние адреса, порты и имена машин конкретных платформ. Наружу платформа публикует один порт 443, а остальное работает внутри вашей сети и описывается при внедрении.
- Готовые правила выхода в интернет для вашей сети. Их состав зависит от того, какими поставщиками языковых моделей вы пользуетесь, и согласуется при внедрении.
- Пароли, ключи и сертификаты. В описателе платформы стоят только имена секретов, а значения приходят извне и в документацию не попадают.
Если нужного ответа в разделе нет, напишите в поддержку. Вопросы, которые повторяются, попадают в план правок раздела.