Складання посібника користувача для 1С-Бітрікс

Складання посібника користувача для 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. Додати товар до розділу / прибрати з розділу

Написання інструкції: конкретика замість опису

Погано: «У розділі управління контентом оберіть потрібний інфоблок і додайте елемент».

Добре:

1. Відкрийте Контент → Каталог товарів у лівому меню адміністративної панелі
2. Натисніть кнопку Додати елемент у правому верхньому куті
3. Заповніть поля:
   • Назва — повна назва товару (наприклад: «Крісло офісне Comfort Pro, чорне»)
   • Символьний код — латиницею через дефіс (наприклад: kreslo-comfort-pro-chorne). Генерується автоматично, але перевірте
   • Артикул (поле «Артикул») — із прайс-листа постачальника
4. Перейдіть на вкладку Зображення, завантажте головне фото (мінімум 800×800 пікс., JPG)
5. Натисніть Зберегти

Кожен крок — одна дія. Називаємо елементи інтерфейсу жирним. Наводимо конкретні приклади заповнення.

Скриншоти: правила та обмеження

Скриншоти прискорюють розуміння, але створюють проблему обслуговування — при оновленні інтерфейсу вони застарівають.

Правило: скриншот потрібен лише для неочевидних елементів інтерфейсу. Якщо кнопка називається «Додати елемент» і одразу видна — скриншот не потрібен. Якщо потрібна опція захована в підменю третього рівня — скриншот обов'язковий.

Вимоги до скриншотів:

• Роздільна здатність: 1920×1080 або вище
• Формат: PNG (не JPEG — текст втрачає якість)
• Анотації: стрілки та виділення через Figma, Snagit або аналоги
• Зберігання: у git-репозиторії поряд із документацією, з іменами step-01-open-menu.png

Посібник менеджера інтернет-магазину

Найбільш затребувані сценарії для менеджера магазину на Бітрікс:

Обробка замовлення:

1. Магазин → Замовлення → Список замовлень
2. Фільтр: статус «Нове», натиснути «Застосувати»
3. Відкрити замовлення, перевірити склад і адресу доставки
4. Натиснути «Змінити», змінити статус на «Прийнято до обробки», натиснути «Зберегти»
5. Клієнт отримає автоматичне сповіщення на email

Повернення товару:

• Не видаляти замовлення — створити повернення через кнопку «Створити повернення» у замовленні
• Вказати позиції до повернення та причину
• Після схвалення — змінити статус замовлення на «Повернення оформлено»

Акції та знижки:

• Магазин → Маркетинг → Правила роботи з цінами
• Кожне правило: умова (від суми, для групи користувачів, на розділ) + дія (знижка %, фіксована знижка, подарунок)
• Пріоритет: менше число = вищий пріоритет. Правило з пріоритетом 10 застосовується раніше правила з пріоритетом 100

Формат та інструменти

Confluence/Notion — для команди з доступом до корпоративних інструментів. Зручно підтримувати актуальність, додавати коментарі.

PDF/DOCX — для офіційної передачі клієнту. Генерується з Markdown або Google Docs.

Вбудована довідка в CMS — кнопки з підказками прямо в адміністративних формах Бітрікс. Реалізується через CAdminHint або додавання title-атрибутів до полів кастомного адміністративного інтерфейсу.

Відеоінструкції — для складних операцій із великою кількістю кроків. Скринкаст тривалістю 3–5 хвилин часто ефективніший за текстову інструкцію. Важливо: зберігати файл проекту (Camtasia, Loom), щоб можна було перезаписати фрагмент, який змінився.

Оновлення посібника

Інструкція без актуалізації — марна. Вбудовуємо оновлення в процес розробки:

• У задачі на зміну інтерфейсу — прапорець «Оновити посібник користувача»
• Після кожного оновлення Бітрікс — перегляд розділів адміністративної панелі, що змінилися
• Щоквартальний review: проходимо всі сценарії з посібника і перевіряємо актуальність

Етапи роботи

Загалом: 2–4 тижні залежно від обсягу функціоналу.