Составление руководства пользователя для 1С-Битрикс
Большинство руководств пользователя для Битрикс-проектов создаются один раз и мгновенно устаревают: скриншот из 2021 года показывает меню, которого больше нет, а инструкция «нажмите на красную кнопку» не работает, потому что кнопку переделали в синюю ссылку. Качественное руководство пользователя — живой документ с понятной структурой, конкретными шагами и механизмом обновления.
Аудитория и её задачи
Прежде чем писать — определяем, кто будет читать и что им нужно сделать. Для Битрикс-проекта обычно несколько групп:
Контент-менеджер — добавляет и редактирует страницы, новости, товары. Работает в визуальном редакторе, административной панели. Не понимает PHP и базы данных. Нужна инструкция по конкретным операциям с конкретными кнопками.
SEO-специалист — настраивает мета-теги, URL-ы, sitemap. Работает в SEO-панели Битрикса и редакторе страниц. Нужно объяснить, где что находится и как изменения применяются.
Менеджер интернет-магазина — обрабатывает заказы, управляет остатками, настраивает акции. Основная работа в модуле «Интернет-магазин». Нужны чёткие сценарии для типовых задач.
Разработчик/администратор — деплой, обновления, права доступа. Нужна техническая документация, а не пользовательская инструкция.
Смешивать аудитории в одном документе — ошибка. Лучше отдельные руководства или чёткие разделы «для кого эта секция».
Структура руководства для контент-менеджера
Эффективная структура строится вокруг задач, а не вокруг пунктов меню:
1. Вход в систему и навигация
2. Работа с новостями
2.1. Добавить новость
2.2. Редактировать опубликованную новость
2.3. Запланировать публикацию на дату
2.4. Снять с публикации (не удалять!)
3. Работа со страницами
3.1. Редактирование текста через визуальный редактор
3.2. Добавление изображений (требования к размеру)
3.3. Управление SEO-параметрами страницы
4. Работа с каталогом товаров
4.1. Добавить товар
4.2. Изменить цену
4.3. Обновить остатки вручную
4.4. Добавить товар в раздел / убрать из раздела
Написание инструкции: конкретика вместо описания
Плохо: «В разделе управления контентом выберите нужный инфоблок и добавьте элемент».
Хорошо:
- Откройте Контент → Каталог товаров в левом меню административной панели
- Нажмите кнопку Добавить элемент в правом верхнем углу
- Заполните поля:
- Название — полное название товара (например: «Кресло офисное Comfort Pro, чёрное»)
-
Символьный код — латиницей через дефис (например:
kreslo-comfort-pro-chyornoe). Генерируется автоматически, но проверьте - Артикул (поле «Артикул») — из прайс-листа поставщика
- Перейдите на вкладку Изображения, загрузите главное фото (минимум 800×800 пикс., JPG)
- Нажмите Сохранить
Каждый шаг — одно действие. Называем элементы интерфейса жирным. Приводим конкретные примеры заполнения.
Скриншоты: правила и ограничения
Скриншоты ускоряют понимание, но создают проблему обслуживания — при обновлении интерфейса они устаревают.
Правило: скриншот нужен только для неочевидных элементов интерфейса. Если кнопка называется «Добавить элемент» и сразу видна — скриншот не нужен. Если нужная опция спрятана в подменю третьего уровня — скриншот обязателен.
Требования к скриншотам:
- Разрешение: 1920×1080 или выше
- Формат: PNG (не JPEG — текст теряет качество)
- Аннотации: стрелки и выделение через Figma, Snagit или аналоги
- Хранение: в git-репозитории рядом с документацией, с именами
step-01-open-menu.png
Руководство менеджера интернет-магазина
Самые востребованные сценарии для менеджера магазина на Битриксе:
Обработка заказа:
- Магазин → Заказы → Список заказов
- Фильтр: статус «Новый», нажать «Применить»
- Открыть заказ, проверить состав и адрес доставки
- Нажать «Изменить», сменить статус на «Принят к обработке», нажать «Сохранить»
- Клиент получит автоматическое уведомление на email
Возврат товара:
- Не удалять заказ — создать возврат через кнопку «Создать возврат» в заказе
- Указать позиции к возврату и причину
- После одобрения — изменить статус заказа на «Возврат оформлен»
Акции и скидки:
- Магазин → Маркетинг → Правила работы с ценами
- Каждое правило: условие (от суммы, для группы пользователей, на раздел) + действие (скидка %, фиксированная скидка, подарок)
- Приоритет: меньшее число = выше приоритет. Правило с приоритетом 10 применяется раньше правила с приоритетом 100
Формат и инструменты
Confluence/Notion — для команды с доступом к корпоративным инструментам. Удобно поддерживать актуальность, добавлять комментарии.
PDF/DOCX — для официальной передачи клиенту. Генерируется из Markdown или Google Docs.
Встроенная справка в CMS — кнопки с подсказками прямо в административных формах Битрикса. Реализуется через CAdminHint или добавление title-атрибутов к полям кастомного административного интерфейса.
Видеоинструкции — для сложных операций с большим количеством шагов. Screencast длиной 3–5 минут часто эффективнее текстовой инструкции. Важно: хранить файл проекта (Camtasia, Loom), чтобы можно было перезаписать изменившийся фрагмент.
Обновление руководства
Инструкция без актуализации бесполезна. Встраиваем обновление в процесс разработки:
- В задаче на изменение интерфейса — чекбокс «Обновить руководство пользователя»
- После каждого обновления Битрикса — просмотр изменившихся разделов административной панели
- Ежеквартальный review: проходим все сценарии из руководства и проверяем актуальность
Этапы работы
| Этап | Содержание | Срок |
|---|---|---|
| Интервью и анализ | Определение аудитории, ключевых задач | 1–2 дня |
| Структура | Оглавление, сценарии использования | 1 день |
| Написание первого черновика | Пошаговые инструкции без скриншотов | 3–7 дней |
| Скриншоты и аннотации | Создание иллюстраций | 1–3 дня |
| Проверка и правки | Тестирование инструкций на реальном пользователе | 1–2 дня |
| Публикация | Размещение в Confluence/PDF | 1 день |
Суммарно: 2–4 недели в зависимости от объёма функционала.