Как устроена документация
Документация состоит из трёх слоёв. Выбор слоя зависит от того, какую работу вы делаете.
Три слоя
Решения — что платформа делает для бизнеса. Пять разделов по продуктовым задачам: автоматизация маркетинга, персонализация баннеров и сторис, лояльность и кэшбек, геймификация, противодействие мошенничеству. В каждом: обзор и ограничения, карта задействованных модулей, сквозные сценарии от пустого экрана до работающего результата.
Модули — что умеет каждая часть платформы. Описание модуля не зависит от решения: сущности, концепции устройства, полный справочник блоков и настроек, практика и отладка.
Платформа — как систему установить, подключить, эксплуатировать и расширять. Сюда относятся разделы «Начало работы», «Интеграция и API», «Администрирование», «Технические концепции», «Кастомизация».
С чего начать
| Ваша задача | Куда идти |
|---|---|
| Понять, решает ли платформа мою задачу | «Решения» → нужное решение → Обзор |
| Развернуть платформу и подключить источники | «Начало работы», затем «Интеграция и API» |
| Настроить сценарий, сегмент, оффер или правило | «Решения» → Сквозные сценарии; детали — «Модули» |
| Найти параметр конкретного блока или сущности | «Модули» → нужный модуль → Справочник |
| Разобраться со сбоем | «Администрирование» → Восстановление; для модуля — «Практика и отладка» |
| Спроектировать внедрение, оценить нагрузки | «Технические концепции» |
| Написать свой адаптер или действие | «Кастомизация» |
| Посчитать эффект на данных платформы | «Технические концепции» → Аналитика |
Соглашения
- Функциональность, которая ещё не выпущена, помечена словом «планируется». Всё остальное описывает работающую версию.
- У возможностей указаны границы применимости: пределы, условия, что решение сознательно не делает.
- Элементы интерфейса оформлены единообразно: кнопки —
[Название], поля — Поле «Название», пути —Меню → Раздел. - Технические инструкции содержат раздел решения проблем.
Если не нашли ответ
Документация покрывает типовые задачи. Если нужного нет — обратитесь к менеджеру проекта или в поддержку: обращение помогает дополнить документацию.