Як працювати з базою знань інстансу?
Коли розділ «База знань» увімкнено для інстансу, ви можете вести внутрішні інструкції та специфікації прямо в Constructor: переглядати їх з головного екрана, шукати у списку, обмежувати доступ за ролями та при потребі переглядати історію змін і відновлювати попередню версію тексту.
Коли знадобиться
- Потрібно швидко відкрити опис процесу або правил роботи команди на цьому інстансі.
- Треба додати або оновити інструкцію після зміни сценарію чи налаштувань.
- Документ має бачити лише певна група ролей — потрібен обмежений доступ.
- Помилково змінили текст і треба повернутися до збереженого раніше варіанту.
Перед початком
- Переконайтеся, що в меню Constructor є пункт «База знань» (або відкрийте його з іконки «?» у верхній панелі). Якщо розділу немає, адміністратор має увімкнути функцію в Налаштування → Налаштування інстансу → блок перемикачів функцій → категорія Instance Docs → перемикач Instance Docs (назви в інтерфейсі можуть бути англійською). Детальніше: налаштування інстансу.
- У інтерфейсі Constructor кнопки «Додати документ» і «Видалити» доступні лише користувачам з повним доступом до керування Instance Docs на інстансі. Редагувати конкретний документ можуть також ролі, зазначені в самому документі як редактори. Інші сценарії (наприклад через API) задає політика інстансу в розпорядженні адміністраторів.
Де відкрити базу знань
- Повний список: пункт «База знань» у бічному меню модуля або перехід на розділ з іконки «?» (допомога) → «База знань».
- Швидкий перегляд: на головному екрані Constructor у блоці документації відображаються до кількох матеріалів; натисніть рядок, щоб відкрити перегляд, або «Всі документи», щоб перейти до списку.
Пошук і фільтри у списку
На сторінці списку ви можете:
- Ввести текст у поле пошуку і натиснути Enter.
- Обрати тип документа (наприклад, інструкція, специфікація, опис flow).
- Відфільтрувати за ботом або без прив’язки до бота.
- Обрати доступ: публічний чи обмежений.
- Показати лише документи закріплені на головній або без них.
Перемикач вигляду «Картки» / «Список» змінює лише оформлення; обраний режим зберігається у браузері.
Створити або змінити документ
- Відкрийте «База знань» → натисніть «Додати документ» (якщо кнопка доступна вашій ролі).
- Заповніть назву — вона обов’язкова. Адресу сторінки (slug) система зазвичай згенерує з назви; за потреби її можна відредагувати.
- Оберіть тип документа — це підказка для команди, на типову поведінку системи це не впливає.
- Налаштуйте доступ:
- Публічний — документ бачать усі, хто має доступ до модуля.
- Обмежений — додайте ролі, яким дозволено читати; без вибору ролей зберегти обмежений документ не вдасться.
- За потреби увімкніть закріплення на головній, щоб документ частіше показувався в блоці на головному екрані.
- Прив’яжіть документ до бота, якщо матеріал стосується лише одного бота (інакше залиште варіант «для будь-якого бота»).
- Поле «Ролі з правом редагування» дозвольте, якщо співавторам без прав адміністратора потрібно змінювати текст. Якщо нікого не обрати, редагувати зможуть лише адміністратори бази знань на рівні інстансу.
- У полі «Що змінилось» коротко опишіть зміни перед збереженням — це допомагає орієнтуватися в історії.
- Введіть текст у основному полі з підтримкою Markdown і натисніть «Зберегти».
Щоб оновити документ із списку або з повноекранного перегляду, натисніть «Редагувати» (якщо кнопка є для вашої ролі).
Вставити тур у документ
Якщо на інстансі налаштовані тури інстансу, під час редагування можна натиснути «Вставити тур» — у текст додасться посилання, а в перегляді з’явиться картка «Запустити тур». Детальніше: Як працювати з турами інстансу.
Переглянути історію та відновити версію
- Відкрийте документ (зі списку, з головного екрана або повноекранний перегляд).
- Натисніть меню з трьох крапок біля заголовка (у модальному вікні або на сторінці документа).
- Оберіть «Історія версій» — відкриється окреме вікно зі списком збережених версій.
- Натисніть потрібну версію, щоб переглянути знімок тексту.
- Якщо у вас є право редагування, стане доступна кнопка відновлення обраної версії — підтвердіть дію. Система спочатку зберігає поточний стан як новий знімок, потім підставляє вміст із обраної версії, щоб ви могли повернутися до попереднього варіанту без втрати історії.
Якщо історія не завантажується і з’являється повідомлення про помилку, найімовірніше, у вас є лише право читання цього документа без права редагування — зверніться до автора або адміністратора.
Видалити документ
Видалення доступне адміністраторам інстансу (повний доступ до керування базою знань). У меню дій оберіть «Видалити» і підтвердіть — дія нескасовна.
Зв’язок із загальною документацією
У блоці на головному екрані може бути посилання на портал документації ConnectiveOne — це окремий сайт з матеріалами для всіх клієнтів. База знань інстансу містить лише те, що створила ваша команда на цьому інстансі.