Створення посібника адміністратора для 1С-Бітрікс
Посібник адміністратора для проекту Бітрікс — це не переказ офіційної документації «1С-Бітрікс». Це опис конкретної інсталяції: які інфоблоки існують і що в них можна редагувати, як працює ланцюжок публікацій, які параметри не можна змінювати і чому. Без такого документа кожен новий адміністратор витрачає тижні на освоєння системи, а половину питань вирішує дзвінком розробнику.
Що має бути в посібнику: структура документа
Типовою структурою посібника для веб-сайту Бітрікс є:
Розділ 1: Доступи та оточення. Адреси адміністративних панелей, тестового та production-серверів. Облікові дані — не в документі, а посилання на менеджер паролів. Опис ролей: хто є головним адміністратором, хто — менеджером контенту, які права має кожна група. Групи користувачів у Бітриксі налаштовуються в /bitrix/admin/groups.php, права модулів — там само.
Розділ 2: Управління контентом. Це становить 40-50% обсягу документа. Для кожного інфоблока: назва, розташування в адмін-меню, які поля обов'язкові, які ні, обмеження (максимальний розмір зображення, допустимі формати файлів). Знімки екрану для кожного нестандартного поля.
Розділ 3: Управління каталогом (для e-commerce). Додавання товарів, управління цінами через модуль catalog, робота з залишками на складі (b_catalog_store_product), управління знижками та купонами в модулі sale.
Розділ 4: Замовлення та покупці. Життєвий цикл замовлення: статуси в /bitrix/admin/sale_order.php, коли та як змінювати статуси, що відбувається при кожному переході (відправляються листи, списуються бонуси).
Розділ 5: Технічні процедури. Резервне копіювання, оновлення ядра, очищення кешу. Адміністратор має розуміти це навіть без розробника.
Опис інфоблоків: шаблон для кожного
Створіть картку для кожного інфоблока за цим шаблоном:
Інфоблок: Новини
Тип: news | ID: 3 | Символьний код: news
Розташування в меню: Контент → Новини
URL адміністративного списку: /bitrix/admin/iblock_list_admin.php?IBLOCK_ID=3&type=news
Поля елемента:
- Назва (NAME) — обов'язкове. Заголовок новини
- Символьний код (CODE) — генерується автоматично, не редагувати
- Дата публікації (ACTIVE_FROM) — якщо не вказана, новина публікується негайно
- Анонс (PREVIEW_TEXT) — короткий опис для списку, до 300 символів
- Зображення анонсу (PREVIEW_PICTURE) — 800×600 px, JPG/PNG, максимум 500 КБ
- Детальний текст (DETAIL_TEXT) — редактор TinyMCE, повний текст новини
- Теги (TAGS) — через кому, використовуються для фільтрації
Що не можна робити:
- Змінювати символьний код опублікованої новини (розриває URL і втрачаються позиції у пошуку)
- Видаляти розділи з активними елементами без переривязування
Цей формат зрозумілий людям без технічного досвіду і не потребує пояснень при кожному запиті.
Опис технічних процедур
Очищення кешу
Найчастіша дія після змін, які «не відображаються» на сайті. Кеш очищується в /bitrix/admin/cache.php. Там два варіанти: очистити весь кеш або тільки кеш конкретного компонента. В посібнику опишіть, що саме очищувати в різних ситуаціях — кеш усього сайту потрібен рідко, зазвичай достатньо кешу розділу.
Якщо сайт використовує HTML-кеш (/bitrix/html_pages/), його потрібно очищувати окремо. В посібнику — окремі інструкції зі шляхом і снімком екрану.
Резервне копіювання
Бітрікс має вбудований модуль резервного копіювання (/bitrix/admin/backup.php). Для посібника опишіть: як створити резервну копію вручну, де вона зберігається, як довго зберігається автоматична копія, і головне — як відновити сайт із резервної копії. Цей крок зазвичай не документують, але він потрібен у критичний момент.
Оновлення модулів
Оновлення у Бітриксі встановлюються через «Marketplace» або через /bitrix/admin/update_system.php. В посібнику: коли оновлювати (не одразу після випуску — дайте час виявити помилки), як перевірити функціональність після оновлення (список сторінок для перевірки), до кого звертатися при проблемах.
Утримання посібника актуальним
Посібник застарівує з кожним оновленням сайту. Встановіть процес: розробник при здачі завдання оновлює відповідний розділ посібника. Для зберігання використовуйте систему з історією версій — Confluence, Notion або навіть Google Docs з історією змін. Файл Word на сервері — анти-паттерн.
Не кладіть посібник у Git-репозиторій проекту — він містить операційну інформацію, не пов'язану з кодом, і часто включає конфіденційні відомості про інфраструктуру.
Специфіка для мультисайтових інсталяцій
Якщо на одному ядрі Бітрікс працює кілька сайтів, посібник має чітко розмежовувати: які інфоблоки спільні, які — специфічні для сайту. Таблиця b_iblock містить поле SITE_ID, за яким прив'язується інфоблок. Адміністратор має розуміти, що зміна «спільного» інфоблока вплине на всі сайти в інсталяції.