← На главную

Создание качественной документации и инструкций для пользователей — это неотъемлемая часть внедрения любой информационной системы. В экосистеме 1С существует несколько подходов к решению этой задачи: от использования специализированных конфигураций до инструментов автоматизации тестирования, которые умеют генерировать обучающие материалы. В этой статье мы подробно разберем наиболее эффективные способы подготовки справочной информации и выясним, какие инструменты лучше всего подходят для различных задач.

Использование Vanessa Automation для создания автоинструкций

Одним из самых современных и технологичных способов является применение инструмента Vanessa Automation. Это бесплатная обработка с открытым исходным кодом, которая позволяет не только тестировать систему, но и автоматически создавать документацию на основе сценариев поведения пользователя. Рассмотрим подробнее, как это работает.

В основе лежит написание сценариев на языке Gherkin (формат "Дано - Когда - Тогда"). Мы описываем действия пользователя в системе, а Vanessa Automation выполняет их в автоматическом режиме. Проанализируем возможности этого инструмента для документации:

1. Генерация различных форматов: Система позволяет выгружать результаты прохождения сценария в файлы форматов Markdown, HTML и PDF. Это дает возможность получить готовую текстовую инструкцию, которая полностью соответствует актуальному интерфейсу программы.
2. Автоматическое создание видеоинструкций: Инструмент может записывать процесс выполнения сценария, добавлять голосовое сопровождение (через синтезаторы речи) и накладывать поясняющие субтитры.
3. Интерактивная "Живая справка": Это уникальная функция, которая позволяет запустить обучение прямо в интерфейсе 1С. Система будет подсвечивать нужные кнопки, открывать формы и выводить подсказки типа "нажми сюда" или "введи это значение", ведя пользователя по бизнес-процессу.
4. Автоматизация скриншотов: При формировании документации Vanessa Automation автоматически делает снимки экрана. Важной особенностью является возможность программного "затирания" конфиденциальных данных на изображениях, таких как суммы или названия контрагентов, что крайне полезно для создания инструкций на реальных данных.

1С:Электронное обучение. Конструктор курсов

Если стоит задача создать не просто текстовый файл, а полноценную интерактивную систему обучения, следует обратить внимание на конфигурацию "1С:Электронное обучение. Конструктор курсов". Часто её путают с системой "1С:Экзаменатор", однако "Конструктор курсов" обладает гораздо более широким функционалом для верстки материалов.

Проанализируем основные функции этого решения:

• Верстка учебных материалов: Внутри конфигурации реализован полноценный редактор, позволяющий структурировать информацию по главам и параграфам, вставлять таблицы, гиперссылки и мультимедийный контент.
• Интерактивные тесты: После изучения инструкции вы можете предложить пользователю пройти тест для закрепления знаний. Результаты тестирования сохраняются в базе, что позволяет администратору или руководителю проекта контролировать уровень подготовки персонала.
• Экспорт в SCORM: Созданные материалы можно экспортировать в общепринятый стандарт дистанционного обучения SCORM. Это позволяет использовать подготовленные в 1С инструкции в сторонних системах управления обучением (LMS), например, в Moodle.

Генерация руководств в СППР (Система проектирования прикладных решений)

Для крупных проектов разработки, где используется СППР, существует встроенная возможность генерации "Руководства пользователя". Этот метод максимально приближен к процессу проектирования системы. Выясним, как это реализовано технически.

В СППР описываются процессы, функции и метаданные будущей или существующей системы. К каждому объекту описания можно привязать текстовые блоки с инструкциями. При необходимости система собирает все эти блоки в единый логически выверенный документ. Это гарантирует, что документация будет соответствовать заложенной архитектуре решения. Рассмотрим, в чем преимущество такого подхода:

• Связь с метаданными: Если меняется функционал объекта, вы сразу видите, какую часть документации нужно обновить.
• Единый стиль: Все разделы руководства будут оформлены единообразно, так как они собираются по заданным шаблонам.

Классическая встроенная справка 1С

Не стоит забывать и о стандартных механизмах платформы "1С:Предприятие". Для каждого объекта конфигурации (справочника, документа, обработки) предусмотрен раздел Справка. Посмотрим на технические особенности ее реализации.

Справка в 1С — это HTML-подобный текст, который редактируется непосредственно в Конфигураторе. Пользователь вызывает её нажатием клавиши F1 или кнопки ? в интерфейсе. Несмотря на критику за "несовременность", у этого метода есть важное преимущество — контекстность. Система открывает именно тот раздел справки, который относится к текущей открытой форме.

Для создания более сложных справочных систем можно использовать внешние файлы формата .chm. Они создаются в сторонних редакторах (например, Help & Manual) и подключаются к конфигурации. Это позволяет использовать сложную навигацию, полнотекстовый поиск и индексацию материалов вне зависимости от кода 1С.

Подход Documentation as Code (Markdown + Git)

В современной разработке на платформе 1С всё чаще применяется подход "Документация как код". Рассмотрим ситуацию, когда инструкции пишутся не в специализированных конфигурациях 1С, а в текстовых файлах формата Markdown.

При использовании среды разработки EDT (Enterprise Development Tool) программисты могут писать документацию в том же проекте, где находится исходный код. Основные шаги этого процесса:

1. Написание текстов: Инструкции пишутся в простых текстовых файлах с разметкой Markdown. Это позволяет легко отслеживать изменения через систему контроля версий Git.
2. Сборка сайта: С помощью генераторов статических сайтов, таких как MkDocs или Hugo, файлы Markdown автоматически преобразуются в красивый и удобный веб-сайт с поиском и навигацией.
3. Публикация: Готовый сайт с инструкциями размещается на внутреннем корпоративном портале. Это избавляет пользователей от необходимости открывать тяжелые файлы Word или искать нужную справку внутри программы.

Рекомендации по выбору инструмента

Подведем итог и выясним, какой инструмент выбрать в зависимости от ваших целей:

• Если вам нужно быстро создать видеоинструкции и поддерживать их в актуальном состоянии при частых изменениях интерфейса — используйте Vanessa Automation.
• Если ваша цель — масштабное обучение сотрудников с проверкой знаний и аттестацией — выбирайте 1С:Электронное обучение. Конструктор курсов.
• Для фундаментального описания архитектуры и функций системы в рамках жизненного цикла разработки идеально подойдет СППР.
• Для небольших пояснений "на месте" лучше всего использовать встроенные механизмы справки в конфигураторе, дополняя их ссылками на внешние базы знаний.

Рассмотрев все варианты, мы видим, что создание инструкций в 1С сегодня — это не просто написание текста, а полноценный технологический процесс, который можно и нужно автоматизировать.