Составление руководства администратора для 1С-Битрикс
Руководство администратора для Битрикс-проекта — это не пересказ официальной документации «1С-Битрикс». Это описание конкретной инсталляции: какие инфоблоки есть и что в них можно редактировать, как работает цепочка публикации, какие настройки трогать нельзя и почему. Без такого документа каждый новый администратор тратит недели на освоение, а половина вопросов решается звонком разработчику.
Что должно быть в руководстве: структура документа
Типовой состав руководства для Битрикс-сайта:
Раздел 1: Доступы и окружение. Адреса административных панелей, тестового и продакшн-серверов. Учётные данные — не в документе, а ссылка на менеджер паролей. Описание ролей: кто является главным администратором, кто — контент-менеджером, какие права у каждой группы. Группы пользователей в Битриксе настраиваются в /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, по которому привязывается инфоблок. Администратор должен понимать, что изменение «общего» инфоблока затронет все сайты инсталляции.