Разработка и поддержка крупных корпоративных систем на базе 1С:Управление торговлей 11 часто сопряжена с привлечением нескольких команд разработчиков, штатных специалистов и внешних субподрядчиков. В таких условиях изменения в конфигурацию вносятся лавинообразно. Если своевременно не фиксировать, кто, зачем и в каких объектах изменил логику, система быстро превратится в «черный ящик». Это приводит к критическим ошибкам при обновлениях, потере производительности и колоссальным затратам на рефакторинг.
В этой статье мы подробно разберем, как выстроить надежный процесс документирования изменений конфигурации, какие классические подходы рекомендует сообщество 1С и какие современные инструменты автоматизации позволяют сделать этот процесс прозрачным и независимым от человеческого фактора.
Ни один, даже самый совершенный инструмент автоматизации не будет работать без четко выстроенного регламента. Первым шагом к наведению порядка является выделение роли технического писателя, ведущего архитектора или системного аналитика, выполняющего функцию «входных ворот» для всех доработок.
Рассмотрим ключевые правила организации процесса:
1С:Управление торговлей.cf с предыдущим стабильным релизом силами встроенного конфигуратора 1С позволяет гарантированно выявить любые недокументированные изменения в кодовой базе и метаданных.Для проектов корпоративного уровня фирма 1С предлагает специализированное решение — «1С:Система проектирования прикладных решений» (СППР). Это мощная база данных, предназначенная для технического проектирования и ведения документации в жесткой привязке к метаданным целевой конфигурации.
Проанализируем основные преимущества использования 1С:СППР:
УТ 11 в СППР. Каждое проектное решение, техническое задание или описание функции будет физически связано со справочниками, документами, регистрами или общими модулями, которые были изменены или добавлены.Если проект масштабный, интеграция 1С:СППР в контур разработки является наиболее системным решением, рекомендованным самой фирмой 1С.
Современным стандартом ведения разработки в крупных командах стал переход на технологию 1C:EDT (Enterprise Development Tools) и использование систем контроля версий Git. Это полностью меняет концепцию документирования, переводя её в плоскость автоматического контроля.
Разберем, как устроен этот процесс:
1C:EDT хранит конфигурацию в виде набора текстовых файлов (XML и модулей BSL). Это позволяет использовать стандартные репозитории Git (GitLab, GitHub, Bitbucket).gitsync или официального инструмента 1С:ГитКонвертер. Это позволит автоматически отслеживать историю изменений вплоть до каждого символа.Писать документацию отдельно в Word-файлах неэффективно: такие файлы быстро устаревают и теряют актуальность. Современный подход заключается в написании технической документации прямо внутри программного кода 1С с использованием стандартизированных комментариев, которые затем автоматически извлекаются специальными парсерами.
Выясним, как это реализовать на практике. Разработчики должны снабжать все экспортные процедуры и функции стандартизированным описанием. Посмотрим на пример оформления функции в модуле 1С:
// Рассчитывает сумму скидки по дисконтной карте для розничных продаж.
//
// Параметры:
// ДисконтнаяКарта - СправочникСсылка.ИнформационныеКарты - Ссылка на карту клиента.
// СуммаДокумента - Число - Исходная сумма покупки до применения скидок.
//
// Возвращаемое значение:
// Число - Рассчитанная сумма скидки в валюте регламентированного учета.
//
Функция РассчитатьСкидкуПоКарте(ДисконтнаяКарта, СуммаДокумента) Экспорт
// Реализация алгоритма расчета...
Возврат СуммаСкидки;
КонецФункции
Для автоматического сбора таких комментариев применяются современные инструменты:
УТ 11, который обновляется при каждом обновлении кода.Для создания пользовательских инструкций, которые не будут устаревать при изменении интерфейсов 1С:Управление торговлей 11, применяется методология BDD (Behavior-Driven Development) и инструмент Vanessa Automation.
Как работает этот подход?
Функционал: Оформление оптовой продажи клиенту
Сценарий: Проведение документа Реализация товаров и услуг
Допустим Я открываю основную форму документа "Реализация товаров и услуг"
И Я нажимаю кнопку "Создать"
Когда Я заполняю реквизит "Партнер" значением "ООО Торговый Дом"
И Я добавляю строку в табличную часть "Товары"
И Я заполняю колонку "Номенклатура" значением "Телевизор со встроенным Smart TV"
И Я заполняю колонку "Количество" значением "5"
И Я нажимаю кнопку "Провести"
Тогда документ проводится без генерации ошибок
При выполнении этого сценария Vanessa Automation может автоматически делать скриншоты экрана на каждом шаге, записывать видеоролики и генерировать готовые иллюстрированные инструкции в формате PDF или HTML. Если подрядчик изменит интерфейс формы в УТ 11, тест упадет. После корректировки теста новая инструкция со свежими скриншотами сгенерируется автоматически за один клик!
Подводя итоги, сформулируем оптимальную стратегию для организации документирования на крупном проекте 1С: