Инструктор. Прототип инструмента создания быстрых пользовательских инструкций

20.09.23

Разработка - Инструментарий разработчика

Прототип дружелюбного и эффективного инструмента для написания пользовательских экспресс-инструкций. Задействована штатная утилита Windows, о существовании которой многие не знают и которая умеет делать огромную работу по логированию действий и снятию скриншотов на всех ПК с Windows (начиная с версии Win7). "Инструктор" не требует никакой установки и дополнительных библиотек! Это означает, что инструмент будет работать и на домашнем ПК и на "чужом ноутбуке" и на терминальном win-сервере у заказчика, где ваши права сильно ограничены. Вы просто подключаете легкую файловую базу 1С и получаете инструмент по снятию скриншотов с интересной функциональностью...

Скачать файлы

Наименование Файл Версия Размер
Инструктор. Выгрузка базы (DT).
.dt 758,88Kb
45
.dt И.1.0.0.1 758,88Kb 45 Скачать бесплатно
Инструктор. Концепция, критичные и перспективные функции.pdf
.pdf 482,71Kb
19
.pdf К.1.0 482,71Kb 19 Скачать бесплатно

Внимание! Прототип "Инструктор" не является готовым инструментом, а лишь демонстрацией возможностей. Для его полноценного использования, требует развития и доработки некоторых обязательных функций.

Тестировался на управляемых формах, на релизах платформы 8.3.11 и выше.

 
 Почему "прототип", а не готовый продукт?

Цель (которая ставилась для конечного инструмента):

  • Сделать дружелюбный инструмент для написания экспресс-инструкций. 
  • Инструмент должен позволять любому, не подкованному в разных утилитах пользователю, не заморачиваясь на сжатие картинок и установку вспомогательных инструментов - делать быстрые инструкции с большим количеством скриншотов. 
  • Время существенно должно экономиться в сравнении с алгоритмами типа “Print Screen -> Paint, Word”, которые, к сожалению, используются начинающими (и не только) специалистами при документировании, обучении пользователей или проработке методологии учета.

Что уже работает в прототипе:

  1. При нажатии кнопки "Rec" в конфигурации 1С, стартует фоновый процесс штатной утилиты PSR (Problem Steps Recorder) встроенной в Windows. Процесс осуществляет детальное логирование действий пользователя.
  2. Логируются все значимые действия в операционной системе (не только в окне 1С), все клики, перетаскивания, ввод текста, запуск программ...
  3. Каждое значимое действие сопровождается текстовым комментарием и скриншотом.
  4. По окончании записи (нажатии кнопки "Stop") - формируется временный MHT-файл (формат MIME HTML). Это делает сама утилита PSR и формат обусловлен её возможностями.
  5. Полученный временный файл разбирается на части, вытаскивается текст по записанным шагам и скриншоты каждого шага.
  6. Запчасти (текстовое описание действия + скриншот) складируются в простейший справочник конфигурации "Инструктор". Вся последовательность шагов записанных за 1 сеанс образует "инструкцию". Инструкции представлены простой группой (папкой) в справочнике. Страницы - соответственно элементами справочника.
  7. Из получившейся инструкции легко удаляются "лишние" шаги (непосредственным удалением). Необходимым для инструкции шагам присваивается имя, корректируется автоматический комментарий к шагу.
  8. На основе обработки с Инфостарта "Рисуем в 1С" от автора Василий Попов, в прототипе накиданы базовые возможности подписать или подрисовать что-либо на скриншотах (средствами js) опять же "внутри 1С".
  9. Рисунки и подписи сохраняются в инструкции.
 
Преимущества подхода
 
Недостатки подхода и текущей версии
 
Что не работает, но хотелось бы видеть в конечном инструменте

конфигурация инструкции windows скриншоты рисование автоматизация прототип javascript js psr

См. также

Infostart Toolkit: Инструменты разработчика 1С 8.3 на управляемых формах

Инструментарий разработчика Роли и права Запросы СКД Платформа 1С v8.3 Управляемые формы Запросы Система компоновки данных Конфигурации 1cv8 Платные (руб)

Набор инструментов программиста и специалиста 1С для всех конфигураций на управляемых формах. В состав входят инструменты: Консоль запросов, Консоль СКД, Консоль кода, Редактор объекта, Анализ прав доступа, Метаданные, Поиск ссылок, Сравнение объектов, Все функции, Подписки на события и др. Редактор запросов и кода с раскраской и контекстной подсказкой. Доработанный конструктор запросов тонкого клиента. Продукт хорошо оптимизирован и обладает самым широким функционалом среди всех инструментов, представленных на рынке.

13000 руб.

02.09.2020    119967    656    389    

701

Infostart PrintWizard

Пакетная печать Печатные формы Инструментарий разработчика Платформа 1С v8.3 Запросы 1С:Зарплата и кадры бюджетного учреждения 1С:Конвертация данных 1С:ERP Управление предприятием 2 1С:Управление торговлей 11 Платные (руб)

Инструмент, позволяющий абсолютно по-новому взглянуть на процесс разработки печатных форм. Благодаря конструктору можно значительно снизить затраты времени на разработку печатных форм, повысить качество и "прозрачность" разработки, а также навести порядок в многообразии корпоративных печатных форм.

18000 руб.

06.10.2023    7018    20    6    

37

Infostart УДиФ: Управление данными и формами

Инструменты администратора БД Инструментарий разработчика Роли и права Платформа 1С v8.3 Конфигурации 1cv8 Россия Платные (руб)

Расширение позволяет без изменения кода конфигурации выполнять проверки при вводе данных, скрывать от пользователя недоступные ему данные, выполнять код в обработчиках. Не изменяет данные конфигурации, легко устанавливается практически на любую конфигурацию на управляемых формах.

10000 руб.

10.11.2023    3253    10    1    

31

SALE! 30%

PowerTools

Инструментарий разработчика Инструменты администратора БД Платформа 1С v8.3 Управляемые формы Конфигурации 1cv8 Россия Платные (руб)

Универсальный инструмент программиста для администрирования конфигураций. Сборник наиболее часто используемых обработок под единым интерфейсом.

3600 2520 руб.

14.01.2013    177356    1071    0    

846

Многопоточность. Универсальный «Менеджер потоков» 2.1

Инструментарий разработчика Платформа 1С v8.3 Конфигурации 1cv8 Россия Платные (руб)

Восстановление партий или взаиморасчетов, расчет зарплаты, пакетное формирование документов или отчетов - теперь все это стало доступнее. * Есть желание повысить скорость работы медленных алгоритмов! Но... * Нет времени думать о реализации многопоточности? * о запуске и остановке потоков? * о поддержании потоков в рабочем состоянии? * о передаче данных в потоки и как получить ответ из потока? * об организации последовательности? Тогда ЭТО - то что надо!!!

5000 руб.

07.02.2018    99207    239    97    

296

[ЕХТ] Фреймворк для Расширений 1С

Инструментарий разработчика Платформа 1С v8.3 Управляемые формы Платные (руб)

"Фреймворк для Расширений 1С" это универсальное и многофункциональное решение, упрощающее разработку и поддержку создаваемых Расширений. Поставляется в виде комплекта из нескольких Расширений с открытым исходным кодом. Работает в любых Конфигурациях в режиме Управляемого приложения с режимом совместимости 8.3.12 и выше без необходимости внесения изменений в Конфигурацию.

3000 руб.

27.08.2019    17921    6    8    

38

1С HTML Шаблоны / HTML Templates

Инструментарий разработчика Платформа 1С v8.3 Конфигурации 1cv8 Платные (руб)

Быстрая и удобная обработка для работы с шаблонами HTML. Позволяет легко и быстро формировать код HTML.

2040 руб.

27.12.2017    27949    3    10    

14

Выполнение произвольного кода или запроса с параметрами через Web-сервис (замена COM-подключений)

Инструментарий разработчика Обмен между базами 1C Платформа 1С v8.3 Платные (руб)

В процессе работы в 1С часто возникает потребность получить данные из другой базы.  Обычно это делается через COM-соединение, и время выполнения запроса при этом оставляет желать лучшего. В данной публикации представлено универсальное решение, позволяющее практически моментально выполнить произвольный код или запрос с параметрами в другой информационной базе через Web-сервис.

2400 руб.

24.09.2019    23494    15    15    

31
Отзывы
8. ROM_NN 84 21.02.19 03:00 Сейчас в теме
Решил тоже запилить видео...
Чтобы было понятнее что делает "Инструктор" и как получается инструкция...
Буду признателен, если те кто скачал уже - поделятся всё-таки размышлениями о применимости и актуальности такого инструмента.
Мыслей много разных по сценариям использования и развитию "Инструктора", но интересен взгляд со стороны.
https://youtu.be/M6XDlYHge2Q
ixijixi; klaus38; +2 Ответить
Остальные комментарии
В избранное Подписаться на ответы Сортировка: Древо развёрнутое
Свернуть все
1. Pr-Mex 136 15.02.19 14:29 Сейчас в теме
(0)
Есть и другие утилиты для создания автоинструкций.
Например, в Vanessa-Automation можно автоматически собирать вот такие ролики
https://www.youtube.com/watch?v=JNnmtv_yWI8&feature=youtu.be
Есть канал в телеграмме, где это обсуждают
https://t.me/testspro1c
Designer1C; awk; sorb; Shmell; JohnyDeath; mas_kot; +6 Ответить
3. ROM_NN 84 15.02.19 14:44 Сейчас в теме
(1)
Vanessa-Automation
безусловно гениальная и актуальная разработка.
Я до того как услышал о ней - подумывал доставать "нормальные" текстовые шаги для "инструктора" через "режим записи журнала действий пользователя"... Но там сложность парсинга тянула на отдельный проект и не стал связываться :)
Имхо, у "Инструктора", если довести до практического использования - немного другое назначение и несколько другой уровень "сложности". Настройка автоматизированного тестирования - не вот уж прям быстрое вхождение в инструмент :)
Если иные пользователи не умеют скриншоты сжимать - какая уж тут настройка клиента и менеджера тестирования.
Повторюсь, Vanessa - безусловно классный инструмент. В рекламе и так не нуждается :)
2. Pr-Mex 136 15.02.19 14:33 Сейчас в теме
(0)
1С плохо "отдаёт" идентификаторы элементов управления (в терминах windows). Надеюсь, что эту особенность платформы поменяют. Помнится какое-то движение в "зазеркалье" под заголовком "улучшение невизуальной доступности" платформы и решений было... Но видимо это никак с аналогичными windows-возможностями не соотносится. Надо развивать и "Инструктор" и платформу 1С в этом вопросе


Начиная с 8.3.12 и дальше в УФ вообще нет индентификаторов элементов форм в терминах windows.
4. ROM_NN 84 15.02.19 14:45 Сейчас в теме
(2) Да, я заметил, что текстовые "расшифровки" после какого-то релиза платформы стали просто никакие :(
Жаль, если это запланированное "развитие" платформы 1С
5. strek_ivan 79 19.02.19 09:14 Сейчас в теме
Было бы неплохо добавить ещё режим плавной анимации скринов. Так оно "компактнее" для восприятия.
6. ROM_NN 84 19.02.19 10:10 Сейчас в теме
(5) В смысле, вместо последовательности страниц (слайдов) сделать gif-анимацию? Или просто плавные переходы при перещелкивании картинок от одной страницы к другой?
Безусловно, в текущем виде, прототип не очень удобен для просмотра инструкций.
Как минимум вывод во внешние форматы нужен для готовых инструкций.

Но спасибо за мнение!
Вы скачачивали? Всё получилось запустить?

Просто забавно - столько раз скачали и никакой обратной связи... Начинаю ощущать дискомфорт )) Вдруг ничего не работает и все молчат... :)
7. strek_ivan 79 19.02.19 10:27 Сейчас в теме
(6) плавные переходы, без необходимости щелкать на каждом слайде; ещё не скачивал, поскольку для этого требуются $m, а их временно не хватает :)
8. ROM_NN 84 21.02.19 03:00 Сейчас в теме
Решил тоже запилить видео...
Чтобы было понятнее что делает "Инструктор" и как получается инструкция...
Буду признателен, если те кто скачал уже - поделятся всё-таки размышлениями о применимости и актуальности такого инструмента.
Мыслей много разных по сценариям использования и развитию "Инструктора", но интересен взгляд со стороны.
https://youtu.be/M6XDlYHge2Q
ixijixi; klaus38; +2 Ответить
9. maxx 991 25.06.21 14:56 Сейчас в теме
Скачал, интересно.

Похоже сломалось отображение на 8.3.18 скриншотов в HTML странице, т.к. в 1С перешли как я понимаю на WebKit, но 8.3.11 всё отображается
11. maxx 991 28.06.21 09:23 Сейчас в теме
(9) посмотрел как в обработке "Рисование в 1С" сделано и поменял функцию ПолучитьОкноБраузера и заработало на 8.3.18

&НаКлиенте
Функция ОкноБраузера()
	
	//Возврат Элементы.СнимокЭкрана.Документ.parentWindow;	
	
	ДокументБраузера = Элементы.СнимокЭкрана.Документ;
	ОкноБраузера = ДокументБраузера.defaultView;
	Возврат ОкноБраузера;

КонецФункции
Показать
15. ROM_NN 84 08.02.22 14:11 Сейчас в теме
(11) Спасибо. Внёс исправления. Выложил новый dt
10. ROM_NN 84 26.06.21 23:39 Сейчас в теме
(9) Спасибо за отзыв :)

Хотел предложить в качестве компенсации за нерабочую программу Вам вторую часть материала (pdf)...
Но судя по транзакциям, вы ее уже скачали :)

Сожалею, что нет времени поправить прототип хотя бы до рабочего состояния.
Нужно будет в описании, пожалуй указать про совместимость не со всеми версиями платформы.
12. lihomanov 83 13.12.21 18:29 Сейчас в теме
Доброго времени суток
на платформе 8.3.18.1520
Вылетает "Аварийное завершение" при остановке записи, подскажите, что посмотреть.
Прикрепленные файлы:
13. ROM_NN 84 14.12.21 22:59 Сейчас в теме
Здравствуйте! Попробую посмотреть в ближайшие 2-3 дня. Давно не проверял с новыми релизами платформы.
14. lihomanov 83 02.02.22 20:28 Сейчас в теме
(13)
Здравствуйте!
Получилось посмотреть ?
16. ROM_NN 84 08.02.22 14:15 Сейчас в теме
(14) Добрый день! Проверил и на указанном релизе 8.3.18.1520 и на нескольких последних релизах 8.3.20.... Нигде не воспроизводится указанное аварийное завершение.
На разных ПК пробовали тоже. На ноутбуке и на серверной ОС...

Сожалею, но не знаю чем помочь в конкретном вашем случае. Если повторяется ошибка - попробуйте получить более полное сообщение об ошибке и выложить доп. информацию.
Но, боюсь, что имеет место какое-то сочетание факторов операционной системы и, может быть платформы.
Попробуйте на другом ПК.

Тем не менее, выкладываю версию 1.0.0.1 с исправлением, приведенным в комментарии № (11). За исправление низкий поклон Максиму Гончарову (aka maxx).

Текущая версия работает на релизах 8.3.18, 8.3.20. Протестировано на нескольких версиях и ПК. Все подряд не вижу смысла тестировать - там всё примитивно до ужаса. Если что-то и сломается, то при существенных изменениях в механизмах платформы 1С. Например, при работе поля HTML-документа.
На 8.3.21 не тестировал...
17. lihomanov 83 12.02.22 07:20 Сейчас в теме
(16)

Информация 1С:
1С:Предприятие 8.3 (8.3.20.1674)
Файловый (без сжатия)

Информация ОС:
Windows server 2019 Standart

Проверил на другом ПК при нажатии на rec, ошибка и при нажатии на stop аварийное завершение
Прикрепленные файлы:
18. Xershi 1473 16.09.23 00:11 Сейчас в теме
(17) очевидно методы поменялись или код обрамить нужно.
19. ROM_NN 84 20.09.23 17:14 Сейчас в теме
(18) Хотел сделать скачивание бесплатным, чтобы никому не было обидно из-за возможной несовместимости с новой платформой. Но:
1. Инфостарт не даёт сделать бесплатное скачивание почему-то
2. Проверил только что на версии 1С:Предприятие 8.3 (8.3.23.1739) внутри RDP-сессии на Win Serv 2019 - всё прекрасно работает. Даже рисовалка поверх слайдов.

Так что извиняйте, если что 🤷‍♂️
20. ROM_NN 84 20.09.23 18:08 Сейчас в теме
(19) О, получилось сделать бесплатным.
Если кто готов внести правки и поделиться бесплатно новой версией - присылайте, могу разместить.
Повторюсь, не подтвердилась поломка методов. Вроде работает всё. Может какая-то редкая ситуация или что-то зарезано слишком сильно в правах под win... Но мне не удалось воспроизвести.
Скачивайте, пользуйтесь, кому любопытно. Всем мир✌️
Оставьте свое сообщение