Upodate flow nodes constructor
Deploy Frontend / build-and-deploy (push) Successful in 27s Details

This commit is contained in:
romanskijdev 2026-07-16 15:44:52 +03:00
parent 47213f17d0
commit 9d24a0edc4
1 changed files with 593 additions and 149 deletions

View File

@ -7,15 +7,31 @@ import {
Group,
Box,
Title,
Table,
Divider,
ActionIcon,
Tooltip,
CopyButton,
ScrollArea,
Badge,
Alert,
UnstyledButton,
Timeline,
ThemeIcon,
} from '@mantine/core'
import { IconArrowLeft, IconBulb, IconAlertTriangle } from '@tabler/icons-react'
import {
IconArrowLeft,
IconCopy,
IconCheck,
IconBulb,
IconAlertTriangle,
} from '@tabler/icons-react'
import { useNavigate } from 'react-router-dom'
// ================================================================
// Структура документации
// ================================================================
interface DocSection {
id: string
title: string
@ -24,11 +40,19 @@ interface DocSection {
const SECTIONS: DocSection[] = [
{ id: 'overview', title: 'Что это такое', level: 1 },
{ id: 'principle-1', title: '1. Чтобы кнопка появилась в боте', level: 1 },
{ id: 'principle-2', title: '2. Как создать новую тему', level: 1 },
{ id: 'principle-3', title: '3. Как изменить существующую тему', level: 1 },
{ id: 'templates', title: 'Сообщение согласующему — важное правило', level: 1 },
{ id: 'check', title: 'Как проверить, что всё работает', level: 1 },
{ id: 'terms', title: 'Три простых понятия', level: 1 },
{ id: 'howto', title: 'Как создать дерево — по шагам', level: 1 },
{ id: 'step-1', title: ' 1. Выбрать категорию', level: 2 },
{ id: 'step-2', title: ' 2. Создать первый узел', level: 2 },
{ id: 'step-3', title: ' 3. Добавить варианты (ветки)', level: 2 },
{ id: 'step-4', title: ' 4. Завершить ветку вводом текста', level: 2 },
{ id: 'step-5', title: ' 5. Настроить сообщение согласующему', level: 2 },
{ id: 'step-6', title: ' 6. Проверить результат', level: 2 },
{ id: 'node-types', title: 'Три типа узлов', level: 1 },
{ id: 'example-1', title: 'Пример: «Отпуска»', level: 1 },
{ id: 'example-2', title: 'Пример: выбор из нескольких списков', level: 1 },
{ id: 'template-basics', title: 'Как писать сообщение согласующему', level: 1 },
{ id: 'tips', title: 'Советы и правила', level: 1 },
{ id: 'troubleshooting', title: 'Если что-то не работает', level: 1 },
]
@ -58,28 +82,43 @@ export default function FlowTreeGuidePage() {
return (
<Box style={{ display: 'flex', gap: 32, alignItems: 'flex-start' }}>
<Box style={{ width: 260, flexShrink: 0, position: 'sticky', top: 20, maxHeight: 'calc(100vh - 40px)' }}>
<Box
style={{
width: 260,
flexShrink: 0,
position: 'sticky',
top: 20,
maxHeight: 'calc(100vh - 40px)',
}}
>
<Stack gap={0}>
<Group justify="space-between" mb="md">
<Text size="xs" fw={600} c="dimmed" tt="uppercase" lts={1}>
Руководство
</Text>
<ActionIcon variant="subtle" size="sm" onClick={() => navigate('/nodes')}>
<ActionIcon
variant="subtle"
size="sm"
onClick={() => navigate('/nodes')}
>
<IconArrowLeft size={16} />
</ActionIcon>
</Group>
<ScrollArea style={{ maxHeight: 'calc(100vh - 120px)' }}>
<Stack gap={2}>
{SECTIONS.map((section) => (
<UnstyledButton
key={section.id}
onClick={() => scrollTo(section.id)}
px={12}
px={section.level === 2 ? 20 : 12}
py={6}
style={{
borderRadius: 4,
backgroundColor:
activeSection === section.id ? 'var(--mantine-color-blue-0)' : 'transparent',
activeSection === section.id
? 'var(--mantine-color-blue-0)'
: 'transparent',
borderLeft:
activeSection === section.id
? '2px solid var(--mantine-color-blue-6)'
@ -87,7 +126,7 @@ export default function FlowTreeGuidePage() {
}}
>
<Text
size="sm"
size={section.level === 2 ? 'xs' : 'sm'}
c={activeSection === section.id ? 'blue.7' : 'dimmed'}
fw={activeSection === section.id ? 600 : 400}
>
@ -100,164 +139,531 @@ export default function FlowTreeGuidePage() {
</Stack>
</Box>
{/* ============================================================ */}
{/* Основной контент */}
{/* ============================================================ */}
<Box style={{ flex: 1, maxWidth: 880, minWidth: 0 }}>
<Stack gap={48} pb={120}>
{/* Заголовок */}
<Box>
<Title order={1}>Как настроить дерево заявок</Title>
<Title order={1}>Как настроить дерево согласования</Title>
<Text c="dimmed" mt="sm" size="lg">
Когда сотрудник создаёт заявку в боте, тот задаёт вопросы по очереди и предлагает
варианты ответа кнопками: «Какой регион?» → «Какая причина?» → «Опишите заявку». Эта
цепочка вопросов и есть <b>дерево</b>, и вы его собираете здесь — без программирования.
Это руководство для тех, кто настраивает бота — без программирования.
Здесь пошагово показано, как собрать «дерево» вопросов, которые бот задаёт
сотруднику, когда тот создаёт заявку: например, «Какой регион?» →
«Какая причина?» → «Опишите заявку».
</Text>
</Box>
<Divider />
{/* ============================================================ */}
{/* ОБЗОР */}
{/* ============================================================ */}
<DocSection id="overview" title="Что это такое" />
<Text>
Каждый <b>раздел заявок</b> («Отпуска», «Возвраты» и т.д.) — это отдельное дерево вопросов.
Каждый вопрос или кнопка внутри дерева — это <b>шаг</b>. Путь, который сотрудник проходит от
первого вопроса до текстового поля, в конце превращается в конкретную тему заявки со своими
согласующими.
Когда сотрудник создаёт заявку в Telegram-боте, бот задаёт ему вопросы по
очереди и предлагает варианты ответов кнопками. Например: «Выберите
регион» → «Крым» или «Краснодар» → «Опишите заявку текстом». Эта
последовательность вопросов и есть <b>дерево</b>.
</Text>
<Callout title="Три вида шагов">
🔘 <b>Кнопка</b> — сотрудник выбирает один из вариантов. 📝 <b>Текстовый ввод</b> — сотрудник
пишет заявку своими словами (этим всегда заканчивается путь). ☑️{' '}
<b>Несколько вариантов сразу</b> — как кнопка, но можно отметить сразу несколько пунктов.
</Callout>
<DocSection id="principle-1" title="1. Чтобы кнопка появилась в боте" />
<Text>Три условия, все должны выполняться одновременно:</Text>
<Stack gap="xs">
<Text size="sm">
<b>а)</b> Раздел, в котором лежит дерево, должен быть создан и активен — если раздела
ещё нет, нажмите «Новый раздел» прямо на странице конструктора.
</Text>
<Text size="sm">
<b>б)</b> От первого вопроса до этой кнопки должен существовать полный путь без обрывов
— то есть у каждого шага на пути есть родитель, а сама кнопка либо ведёт дальше, либо
заканчивается текстовым вводом.
</Text>
<Text size="sm">
<b>в)</b> Сотруднику должно быть выдано право видеть этот раздел. Это отдельная
настройка прав доступа — она делается ПОСЛЕ того, как дерево готово, в другом разделе
системы, не здесь.
</Text>
</Stack>
<Callout title="Если кнопка не появляется">
Сначала проверьте (а) и (б) — они настраиваются прямо в конструкторе. Если с деревом всё в
порядке — дело в правах доступа (в), обратитесь к тому, кто их настраивает.
</Callout>
<DocSection id="principle-2" title="2. Как создать новую тему" />
<Text>Порядок действий с нуля:</Text>
<Stack gap="xs">
<Text size="sm">
<b>Шаг 1.</b> На странице конструктора нажмите «Новый раздел», если подходящего ещё
нет — впишите название, технический код заполнится сам.
</Text>
<Text size="sm">
<b>Шаг 2.</b> Нажмите «Добавить первый вопрос» — это то, что сотрудник увидит первым.
</Text>
<Text size="sm">
<b>Шаг 3.</b> Наведите на созданный шаг, нажмите «+» и добавьте варианты ответа. У всех
кнопок одного вопроса поле «что запомнить» должно совпадать — конструктор подставляет
его сам, начиная со второй кнопки.
</Text>
<Text size="sm">
<b>Шаг 4.</b> Каждую ветку обязательно завершите шагом «Текстовый ввод» — без него
сотрудник не сможет закончить заявку.
</Text>
<Text size="sm">
<b>Шаг 5.</b> В окне редактирования любого шага есть кнопка «Проверить» — она покажет,
появилась ли для этого пути настроенная тема в системе. Если её ещё нет — рядом
появится кнопка «Создать тему», нажмите её, ничего искать в других разделах не нужно.
</Text>
<Text size="sm">
<b>Шаг 6.</b> На самом первом (корневом) шаге дерева настройте текст сообщения
согласующему — см. следующий раздел, это важно.
</Text>
</Stack>
<DocSection id="principle-3" title="3. Как изменить существующую тему" />
<Text>
Найдите нужный раздел в выпадающем списке, разверните дерево и нажмите ✏️ на шаге, который
хотите поменять. Можно переименовать шаг, поменять подсказку для текстового ввода, добавить
новые варианты ответа или переставить шаги местами кнопками ↑ ↓ (среди соседних) и стрелками
с отступом (поднять/опустить на другой уровень вложенности). Все изменения сохраняются
сразу, отдельной кнопки «Сохранить» нет.
Вы настраиваете это дерево в разделе «Конструктор деревьев» — без единой
строчки кода. Каждый вопрос и каждая кнопка — это отдельный «узел», который
вы добавляете через простую форму.
</Text>
<Callout title="Осторожно с удалением">
Удаление шага удаляет и все шаги, которые находятся под ним. Система переспросит перед
удалением.
<Callout title="Зачем это нужно">
Так настраиваются любые сценарии: отпуска, больничные, внебюджетные
расходы, возвраты и любые другие заявки. Если появится новый вид заявки —
не нужно ничего программировать, достаточно собрать новое дерево здесь.
</Callout>
<DocSection id="templates" title="Сообщение согласующему — важное правило" />
<Alert icon={<IconAlertTriangle size={16} />} color="orange" variant="light">
<Text size="sm" fw={600}>
Текст сообщения и код темы настраиваются ОДИН РАЗ — на самом первом (корневом) шаге
дерева, а не на каждой отдельной ветке.
</Text>
</Alert>
{/* ============================================================ */}
{/* ТРИ ПОНЯТИЯ */}
{/* ============================================================ */}
<DocSection id="terms" title="Три простых понятия" />
<Text>
Прежде чем начать, важно понимать всего три вещи:
</Text>
<Table withTableBorder withColumnBorders mt="md">
<Table.Thead>
<Table.Tr>
<Table.Th style={{ width: 180 }}>Понятие</Table.Th>
<Table.Th>Что это простыми словами</Table.Th>
</Table.Tr>
</Table.Thead>
<Table.Tbody>
<Table.Tr>
<Table.Td><b>Категория</b></Table.Td>
<Table.Td>
Раздел заявок, который вы выбираете вверху страницы («Отпуска»,
«Внебюджетные расходы» и т.д.). Одно дерево всегда строится
внутри одной категории.
</Table.Td>
</Table.Tr>
<Table.Tr>
<Table.Td><b>Узел</b></Table.Td>
<Table.Td>
Один шаг в дереве: кнопка с вариантом ответа, поле ввода текста
или список для множественного выбора. Узлы соединяются друг с
другом — у каждого может быть несколько «детей» (следующих
шагов).
</Table.Td>
</Table.Tr>
<Table.Tr>
<Table.Td><b>Тема заявки</b></Table.Td>
<Table.Td>
То, во что в итоге превращается пройденный сотрудником путь по
дереву. Например, путь «Крым → За свой счёт» превращается в
конкретную тему заявки со своими согласующими.
</Table.Td>
</Table.Tr>
</Table.Tbody>
</Table>
<Callout title="Главное правило">
Дерево — это как схема метро: от начальной станции (первого вопроса) до
конечной (поля ввода текста) должен существовать путь через любые
промежуточные станции (кнопки-варианты). Ваша задача — построить эти пути.
</Callout>
{/* ============================================================ */}
{/* ПОРЯДОК СОЗДАНИЯ */}
{/* ============================================================ */}
<DocSection id="howto" title="Как создать дерево — по шагам" />
<Text>
Ниже — точный порядок действий от пустой категории до готового,
работающего дерева.
</Text>
<DocSection id="step-1" title="Шаг 1. Выбрать категорию" level={2} />
<Text>
Откройте страницу «Конструктор деревьев» и в выпадающем списке «Категория»
выберите нужный раздел. Если подходящей категории ещё нет — обратитесь к
администратору, чтобы её создали (это отдельная настройка, не относится к
дереву).
</Text>
<Callout title="Совет">
Если дерево для этой категории уже существует, вы увидите его сразу после
выбора. Можно смело редактировать — все изменения сохраняются
автоматически, ничего не потеряется.
</Callout>
<DocSection id="step-2" title="Шаг 2. Создать первый узел" level={2} />
<Text>
Нажмите кнопку «Добавить корневой узел». Это будет самый первый вопрос,
который увидит сотрудник. Откроется окно с тремя полями:
</Text>
<Table withTableBorder withColumnBorders mt="xs">
<Table.Thead>
<Table.Tr>
<Table.Th style={{ width: 180 }}>Поле</Table.Th>
<Table.Th>Что писать</Table.Th>
</Table.Tr>
</Table.Thead>
<Table.Tbody>
<Table.Tr>
<Table.Td>Тип узла</Table.Td>
<Table.Td>Оставьте «Кнопка» — для первого шага почти всегда нужна кнопка</Table.Td>
</Table.Tr>
<Table.Tr>
<Table.Td>Название</Table.Td>
<Table.Td>То, что увидит сотрудник, например «Отпуска»</Table.Td>
</Table.Tr>
<Table.Tr>
<Table.Td>Ключ</Table.Td>
<Table.Td>
Не трогайте — заполняется автоматически из названия
</Table.Td>
</Table.Tr>
</Table.Tbody>
</Table>
<Text mt="sm">
Если раньше вы пытались настроить отдельное сообщение на каком-то шаге в середине дерева и
оно «не сохранялось» или не действовало — вот почему: система всегда смотрит только на
самый первый шаг. Чтобы сообщение отличалось в зависимости от выбора сотрудника, в тексте
используются условия — но настраивается это тоже на первом шаге, одним общим текстом.
Нажмите «Создать». Узел появится в дереве — с него всё и начинается.
</Text>
<DocSection id="step-3" title="Шаг 3. Добавить варианты (ветки)" level={2} />
<Text>
Наведите на созданный узел — рядом появятся кнопки. Нажмите «+», чтобы
добавить к нему дочерний узел — следующий шаг вопроса. Повторяйте это для
каждого варианта ответа.
</Text>
<Text>
Например, если первый узел — «Тип отпуска», добавьте к нему детей:
«Отпуск», «Отгул», «Больничный». Каждый из них — отдельная кнопка, которую
увидит сотрудник после выбора первого шага.
</Text>
<Callout title="Важно про DataKey и DataValue" mt="md">
Для узлов-кнопок в форме есть два поля: <b>DataKey</b> — название того, что
мы запоминаем (например «тип отпуска»), и <b>DataValue</b> — конкретное
значение этой кнопки (например «отпуск»). У всех кнопок-веток одного и того
же вопроса DataKey должен быть одинаковым, а DataValue — у каждой свой.
Смотрите готовый пример ниже — там всё видно на конкретных значениях.
</Callout>
<DocSection id="step-4" title="Шаг 4. Завершить ветку вводом текста" level={2} />
<Text>
Каждая ветка дерева обязательно должна заканчиваться узлом «Текстовый
ввод» — это последний шаг, где сотрудник пишет саму заявку своими словами.
Добавьте такой узел к каждому «листу» дерева (к узлу, у которого больше нет
вариантов выбора).
</Text>
<Text>
В форме выберите тип узла «Текстовый ввод» и заполните поле «Подсказка» —
это пример того, что должен написать сотрудник, чтобы ему было понятнее.
</Text>
<Callout title="Как проверить, что дерево готово">
Пройдите мысленно (или на бумаге) каждый путь от первого узла до конца.
Если какой-то путь обрывается на кнопке, не доходя до текстового ввода —
сотрудник не сможет завершить заявку. Добавьте туда узел ввода.
</Callout>
<DocSection id="step-5" title="Шаг 5. Настроить сообщение согласующему" level={2} />
<Text>
На узле, где заявка «превращается» в конкретную тему (обычно это последний
узел-кнопка перед вводом текста), можно раскрыть блок «Шаблоны сообщения и
кода темы» и задать, как будет выглядеть уведомление у согласующего в
Telegram. Подробно про это — в разделе{' '}
<Text component="span" fw={600}>«Как писать сообщение согласующему»</Text>{' '}
ниже. Если ничего не менять — сработает оформление по умолчанию.
</Text>
<DocSection id="step-6" title="Шаг 6. Проверить результат" level={2} />
<Text>
Дерево сохраняется автоматически после каждого действия — отдельной кнопки
«Сохранить всё» нажимать не нужно. Лучший способ проверить готовое дерево —
попросить коллегу создать тестовую заявку через бота и убедиться, что все
вопросы задаются в правильном порядке, а итоговое сообщение согласующему
выглядит понятно.
</Text>
{/* ============================================================ */}
{/* ТИПЫ УЗЛОВ */}
{/* ============================================================ */}
<DocSection id="node-types" title="Три типа узлов" />
<Text>
При создании или редактировании узла вы выбираете один из трёх типов:
</Text>
<Stack gap="sm" mt="md">
<Paper withBorder p="md">
<Group gap="xs" mb={4}>
<Text size="lg">🔘</Text>
<Text fw={600}>Кнопка</Text>
</Group>
<Text size="sm" c="dimmed">
Сотрудник нажимает и переходит к следующему шагу. Используется для
любого выбора из вариантов: регион, тип заявки, филиал и т.д.
Требует заполнения DataKey и DataValue.
</Text>
</Paper>
<Paper withBorder p="md">
<Group gap="xs" mb={4}>
<Text size="lg">📝</Text>
<Text fw={600}>Текстовый ввод</Text>
</Group>
<Text size="sm" c="dimmed">
Сотрудник печатает текст. Всегда завершает ветку дерева — после
него бот создаёт заявку. Требует заполнения «Подсказки» —
примера того, что нужно написать.
</Text>
</Paper>
<Paper withBorder p="md">
<Group gap="xs" mb={4}>
<Text size="lg">☑️</Text>
<Text fw={600}>Мультивыбор</Text>
</Group>
<Text size="sm" c="dimmed">
Сотрудник может отметить сразу несколько вариантов (например,
несколько систем: «ОКБ» и «1С»). Все отмеченные варианты
сохранятся вместе, через запятую.
</Text>
</Paper>
</Stack>
{/* ============================================================ */}
{/* ПРИМЕР 1 */}
{/* ============================================================ */}
<DocSection id="example-1" title="Пример: дерево «Отпуска»" />
<Text>
Разберём готовый пример целиком — от первого узла до отправки заявки.
Сценарий: сотрудник выбирает тип отсутствия, затем способ оплаты, затем
пишет причину.
</Text>
<Timeline active={5} bulletSize={28} lineWidth={2} mt="md">
<Timeline.Item title="Корневой узел">
<Text size="sm" c="dimmed">
Название: <Code>Тип отсутствия</Code>. Тип узла: Кнопка. Это
«заголовок» дерева — сам по себе кнопкой сотруднику не показывается,
но от него отходят первые варианты.
</Text>
</Timeline.Item>
<Timeline.Item title="Три дочерних узла-кнопки">
<Text size="sm" c="dimmed">
Добавляем к корню три узла: <Code>Отпуск</Code>, <Code>Отгул</Code>,{' '}
<Code>Больничный</Code>. У всех трёх DataKey одинаковый —{' '}
<Code>absence_type</Code>, а DataValue разный: <Code>vacation</Code>,{' '}
<Code>timeoff</Code>, <Code>sickleave</Code>.
</Text>
</Timeline.Item>
<Timeline.Item title="Способ оплаты — для каждой ветки">
<Text size="sm" c="dimmed">
К узлу «Отпуск» добавляем два дочерних узла: <Code>За свой счёт</Code>{' '}
и <Code>В счёт отпуска</Code>. DataKey у обоих —{' '}
<Code>payment_type</Code>, DataValue — <Code>own_expense</Code> и{' '}
<Code>vacation_account</Code> соответственно. Аналогично поступаем с
ветками «Отгул» и «Больничный».
</Text>
</Timeline.Item>
<Timeline.Item title="Текстовый ввод — конец каждой ветки">
<Text size="sm" c="dimmed">
К каждому из узлов способа оплаты добавляем узел «Текстовый ввод» с
подсказкой: <Code>Укажите даты отпуска, например: 22.02.2026 — 25.02.2026</Code>.
</Text>
</Timeline.Item>
<Timeline.Item title="Сообщение согласующему">
<Text size="sm" c="dimmed">
На узле способа оплаты (там, где заявка уже точно определена)
открываем «Шаблоны сообщения и кода темы» и вписываем текст — см.
пример ниже.
</Text>
</Timeline.Item>
</Timeline>
<CodeBlock
title="Пример: сообщение, которое меняется в зависимости от выбора"
code={`📋 <b>{{if eq .branch "f1"}}Филиал 1{{else}}Филиал 2{{end}}</b>
title="Дерево целиком выглядит так"
code={`Тип отсутствия
├── Отпуск (absence_type = vacation)
│ ├── За свой счёт (payment_type = own_expense) → Ввод текста
│ └── В счёт отпуска (payment_type = vacation_account) → Ввод текста
├── Отгул (absence_type = timeoff)
│ ├── За свой счёт (payment_type = own_expense) → Ввод текста
│ └── В счёт отпуска (payment_type = vacation_account) → Ввод текста
└── Больничный (absence_type = sickleave)
└── Официальный (payment_type = official) → Ввод текста`}
/>
<Text mt="sm">
Что увидит сотрудник в боте: сначала кнопки «Отпуск / Отгул /
Больничный», затем — «За свой счёт / В счёт отпуска», затем поле для
ввода дат. Три нажатия и один текст — заявка готова.
</Text>
<CodeBlock
title="Пример текста сообщения согласующему (поле «Шаблон сообщения»)"
code={`📋 <b>Тип: {{.absence_type_label}}</b>
<b>{{.initiator_name}}</b> просит согласовать: {{.payment_type_label}}
{{.content}}`}
/>
<Text size="sm" c="dimmed" mt="xs">
Всё, что в фигурных скобках — подставится автоматически: название узла,
который выбрал сотрудник, его имя и текст, который он написал. Про этот
синтаксис подробнее — в разделе ниже.
</Text>
{/* ============================================================ */}
{/* ПРИМЕР 2 */}
{/* ============================================================ */}
<DocSection id="example-2" title="Пример: выбор из нескольких списков" />
<Text>
Более сложный, но частый случай: нужно спросить у сотрудника два
независимых параметра подряд — например, филиал и тип расхода.
</Text>
<CodeBlock
title="Структура"
code={`Внебюджетные расходы
├── Филиал 1 (branch = f1)
│ ├── ТМЦ (expense_type = tmc) → Ввод текста
│ └── Расходы (expense_type = expense) → Ввод текста
└── Филиал 2 (branch = f2)
├── ТМЦ (expense_type = tmc) → Ввод текста
└── Расходы (expense_type = expense) → Ввод текста`}
/>
<Text mt="sm">
Обратите внимание: узел «ТМЦ» повторяется дважды — под «Филиал 1» и под
«Филиал 2». Это нормально: узлы с одинаковым названием на разных ветках
дерева — это разные, независимые узлы, у каждого свой ключ (система
добавляет к ключу префикс родителя автоматически).
</Text>
<CodeBlock
title="Пример сообщения согласующему"
code={`📋 <b>Внебюджетные расходы — {{.branch_label}} ({{.expense_type_label}})</b>
<b>{{.initiator_name}}</b>:
{{.content}}`}
/>
<Text mt="sm">
Не нужно запоминать этот синтаксис — на первом шаге дерева есть кнопка «Сформировать
черновик», которая сама подставит условия на основе первого вопроса дерева. Дальше можно
поправить текст руками и сразу посмотреть, как он будет выглядеть, через «Проверить готовую
ветку» в том же окне.
</Text>
<Text size="sm" c="dimmed" mt="xs">
Поле «Код темы» почти всегда можно оставить пустым — тогда код соберётся сам из всех
выборов сотрудника.
</Text>
<DocSection id="check" title="Как проверить, что всё работает" />
{/* ============================================================ */}
{/* ШАБЛОНЫ */}
{/* ============================================================ */}
<DocSection id="template-basics" title="Как писать сообщение согласующему" />
<Text>
Под деревом есть блок «Проверка дерева» с кнопкой «Проверить все ветки» — он пройдёт по
каждому возможному пути и покажет, для всех ли есть настроенная тема. Это быстрее, чем
вручную проходить весь сценарий в Telegram, и находит проблему до того, как её найдёт
сотрудник.
В блоке «Шаблоны сообщения и кода темы» вы пишете обычный текст с
HTML-разметкой (<Code>&lt;b&gt;жирный&lt;/b&gt;</Code>,{' '}
<Code>&lt;i&gt;курсив&lt;/i&gt;</Code>) — так, как хотите видеть уведомление
у согласующего. В нужных местах вставляете «плейсхолдеры» в фигурных
скобках — они подставляются автоматически.
</Text>
<Table withTableBorder withColumnBorders mt="md">
<Table.Thead>
<Table.Tr>
<Table.Th style={{ width: 260 }}>Что написать</Table.Th>
<Table.Th>Что подставится</Table.Th>
</Table.Tr>
</Table.Thead>
<Table.Tbody>
<Table.Tr>
<Table.Td><Code>{`{{.initiator_name}}`}</Code></Table.Td>
<Table.Td>Имя сотрудника, который создал заявку</Table.Td>
</Table.Tr>
<Table.Tr>
<Table.Td><Code>{`{{.content}}`}</Code></Table.Td>
<Table.Td>Текст, который сотрудник ввёл на последнем шаге</Table.Td>
</Table.Tr>
<Table.Tr>
<Table.Td><Code>{`{{.название_кнопки_label}}`}</Code></Table.Td>
<Table.Td>
Название выбранной сотрудником кнопки. Например, если DataKey
кнопки — <Code>region</Code>, пишите{' '}
<Code>{`{{.region_label}}`}</Code>, и туда подставится «Крым» или
«Краснодар» — смотря что выбрал сотрудник
</Table.Td>
</Table.Tr>
</Table.Tbody>
</Table>
<Callout title="Проще всего — по аналогии" mt="md">
Не нужно запоминать синтаксис. Откройте похожий уже настроенный узел (в
этой же или другой категории), скопируйте оттуда шаблон и замените
плейсхолдеры на DataKey ваших узлов.
</Callout>
<Text mt="md">
Дополнительно доступны несколько простых условий — пригодятся, если
сообщение должно немного отличаться в зависимости от выбора:
</Text>
<CodeBlock
title="Показать текст, только если поле заполнено"
code={`{{if .payment_type_label}}Способ оплаты: {{.payment_type_label}}{{end}}`}
/>
<CodeBlock
title="Показать разный текст в зависимости от выбора"
code={`{{if eq .absence_type "vacation"}}Отпуск{{else}}Отгул{{end}}`}
/>
<Text size="sm" c="dimmed" mt="xs">
Поле «Шаблон кода темы» обычно можно не трогать — если оставить пустым,
система сама соберёт код заявки из всех выборов сотрудника. Заполняйте его
только если вам явно сказали, что для этой темы нужен особый код
(например, если это уже настроенная в системе тема с заранее заданным
названием).
</Text>
{/* ============================================================ */}
{/* СОВЕТЫ */}
{/* ============================================================ */}
<DocSection id="tips" title="Советы и правила" />
<Stack gap="sm" mt="md">
<TipEntry
title="Одинаковый DataKey у братьев"
text="Все узлы-кнопки, отходящие от одного и того же родителя, должны иметь одинаковый DataKey (например, все — region), а DataValue у каждого — свой (crimea, krasnodar). Иначе бот запутается, какой ответ на какой вопрос сохранён."
/>
<TipEntry
title="Каждая ветка должна заканчиваться вводом текста"
text="Если ветка обрывается на кнопке — сотрудник не сможет закончить заявку. Всегда добавляйте узел «Текстовый ввод» в конце каждого пути."
/>
<TipEntry
title="Название узла — то, что видит сотрудник"
text="Пишите названия узлов понятно и коротко: то, что вы вводите в поле «Название», один в один появится кнопкой в Telegram."
/>
<TipEntry
title="Ключ трогать не обязательно"
text="Поле «Ключ» заполняется автоматически из названия — это техническая метка, которую использует система внутри себя. Менять его вручную нужно, только если он получился слишком длинным или непонятным."
/>
<TipEntry
title="Изменения сохраняются сразу"
text="Не нужно искать кнопку «Сохранить дерево» — каждое действие (добавление, редактирование, перемещение, удаление узла) применяется мгновенно."
/>
<TipEntry
title="Удаление узла удаляет и всё, что под ним"
text="Если вы удаляете узел, у которого есть дочерние узлы — они удалятся вместе с ним. Система предупредит об этом перед удалением."
/>
</Stack>
{/* ============================================================ */}
{/* ДИАГНОСТИКА */}
{/* ============================================================ */}
<DocSection id="troubleshooting" title="Если что-то не работает" />
<Text>
Частые ситуации и что с ними делать:
</Text>
<Stack gap="md" mt="md">
<ErrorEntry
title="Бот не находит тему после всех вопросов"
description="Набор ответов сотрудника не совпал ни с одной настроенной темой."
resolution="Откройте конструктор, найдите этот путь и нажмите «Проверить» в окне редактирования последнего шага — если темы нет, там же можно её создать."
title="Бот не находит тему заявки после всех вопросов"
description="Это значит, что набор выборов сотрудника не совпал ни с одной настроенной темой в системе."
resolution="Проверьте узел, где задан код темы (поле «Код темы» или шаблон кода) — сверьте его с администратором системы, который заводит темы заявок."
/>
<ErrorEntry
title="Я поменял сообщение, но согласующий видит старый текст"
description="Скорее всего, текст был изменён не на самом первом (корневом) шаге дерева."
resolution="Откройте редактирование первого шага дерева — сообщение настраивается только там."
title="В сообщении согласующему вместо текста написано «<no value>»"
description="Шаблон сообщения ссылается на вариант, который сотрудник не выбирал на этом пути."
resolution="Проверьте, что в дереве действительно есть узел с таким DataKey на пути к этому сообщению, и уберите из шаблона лишние плейсхолдеры."
/>
<ErrorEntry
title="Кнопка не появляется у сотрудника"
description="Либо путь до неё оборван, либо не выданы права на раздел."
resolution="Проверьте цепочку шагов в конструкторе; если с деревом всё в порядке — обратитесь по поводу прав доступа."
title="Система не даёт сохранить узел — «ключ уже используется»"
description="В этой же категории уже есть узел с таким же техническим ключом."
resolution="Измените название узла (ключ сгенерируется заново) или вручную поправьте поле «Ключ» на уникальное значение."
/>
<ErrorEntry
title="Не получается сохранить шаг — «ключ уже используется»"
description="В этом разделе уже есть шаг с таким же техническим ключом."
resolution="Немного измените название — ключ пересоберётся сам."
title="Не получается переместить узел"
description="Система не разрешает сделать узел «родителем самого себя» — например, перетащить ветку внутрь её же собственного потомка."
resolution="Выберите другого родителя, который не находится ниже перемещаемого узла по дереву."
/>
<ErrorEntry
title="Сотрудник дошёл до конца, а кнопки «Отправить» нет"
description="Скорее всего, эта ветка дерева не заканчивается узлом «Текстовый ввод»."
resolution="Найдите последнюю кнопку в этой ветке и добавьте к ней дочерний узел типа «Текстовый ввод»."
/>
</Stack>
<Divider mt="xl" />
<Text size="sm" c="dimmed" ta="center">
Остались вопросы — обратитесь к тому, кто настраивал вам эту систему.
Остались вопросы — обратитесь к администратору системы согласований.
</Text>
</Stack>
</Box>
@ -265,10 +671,18 @@ export default function FlowTreeGuidePage() {
)
}
function DocSection({ id, title }: { id: string; title: string }) {
// ================================================================
// Вспомогательные компоненты
// ================================================================
function DocSection({ id, title, level = 1 }: { id: string; title: string; level?: number }) {
return (
<Box id={id} pt={8}>
<Title order={2}>{title}</Title>
{level === 1 ? (
<Title order={2}>{title}</Title>
) : (
<Title order={3} c="dimmed">{title}</Title>
)}
</Box>
)
}
@ -276,11 +690,23 @@ function DocSection({ id, title }: { id: string; title: string }) {
function CodeBlock({ title, code }: { title: string; code: string }) {
return (
<Paper withBorder mt="md">
<Box px="sm" py={6} style={{ borderBottom: '1px solid var(--mantine-color-gray-3)' }}>
<Text size="xs" fw={600} c="dimmed" tt="uppercase" lts={0.5}>
{title}
</Text>
</Box>
<Group justify="space-between" px="sm" py={6} style={{ borderBottom: '1px solid var(--mantine-color-gray-3)' }}>
<Text size="xs" fw={600} c="dimmed" tt="uppercase" lts={0.5}>{title}</Text>
<CopyButton value={code}>
{({ copied, copy }) => (
<Tooltip label={copied ? 'Скопировано' : 'Копировать'}>
<ActionIcon
size="xs"
variant="subtle"
color={copied ? 'teal' : 'gray'}
onClick={copy}
>
{copied ? <IconCheck size={14} /> : <IconCopy size={14} />}
</ActionIcon>
</Tooltip>
)}
</CopyButton>
</Group>
<Box p="sm">
<Code block style={{ fontSize: 12, whiteSpace: 'pre-wrap', lineHeight: 1.5 }}>
{code}
@ -290,33 +716,51 @@ function CodeBlock({ title, code }: { title: string; code: string }) {
)
}
function Callout({ title, children }: { title: string; children: React.ReactNode }) {
function Callout({ title, children, mt = 'md' }: { title: string; children: React.ReactNode; mt?: string }) {
return (
<Alert variant="light" color="blue" icon={<IconBulb size={16} />} title={title} mt="md">
<Alert
variant="light"
color="blue"
icon={<IconBulb size={16} />}
title={title}
mt={mt}
styles={{
title: { fontSize: 13, fontWeight: 600 },
message: { fontSize: 13 },
}}
>
{children}
</Alert>
)
}
function TipEntry({ title, text }: { title: string; text: string }) {
return (
<Group gap="md" align="flex-start" wrap="nowrap">
<ThemeIcon variant="light" color="teal" size={28} radius="xl" style={{ flexShrink: 0 }}>
<IconBulb size={16} />
</ThemeIcon>
<Box>
<Text size="sm" fw={600}>{title}</Text>
<Text size="sm" c="dimmed">{text}</Text>
</Box>
</Group>
)
}
function ErrorEntry({ title, description, resolution }: { title: string; description: string; resolution: string }) {
return (
<Paper withBorder p="sm">
<Group gap="xs" mb={4}>
<IconAlertTriangle size={16} color="var(--mantine-color-orange-6)" />
<Text size="sm" fw={600}>
{title}
</Text>
<ThemeIcon variant="light" color="orange" size={22} radius="xl">
<IconAlertTriangle size={13} />
</ThemeIcon>
<Text size="sm" fw={600}>{title}</Text>
</Group>
<Text size="sm" c="dimmed">
{description}
</Text>
<Text size="sm" c="dimmed">{description}</Text>
<Text size="sm" mt={4}>
<Text span fw={600}>
Что делать:{' '}
</Text>
<Text span c="dimmed">
{resolution}
</Text>
<Text span fw={600}>Что делать: </Text>
<Text span c="dimmed">{resolution}</Text>
</Text>
</Paper>
)