Автоматизация процесса формирования комплекта руководств по эксплуатации для семейств эксплуатируемых объектов Текст научной статьи по специальности «Строительство и архитектура»

Современные инновации, системы и технологии // Modern Innovations, Systems and Technologies

2023 3(4) eISSN: 2782-2818 https://www.oajmist.com

УДК: 004.91 EDN: MAOJPE

DOI: https://doi.org/10.47813/2782-2818-2023-3-4-0332-0341

Автоматизация процесса формирования комплекта руководств по эксплуатации для семейств эксплуатируемых объектов

Ю. В. Полищук, Я. В. Гончарова

Московский технический университет связи и информатики, г. Москва, Россия

Аннотация. В рамках данной работы предложен способ автоматизации процесса формирования комплекта руководств по эксплуатации для семейств эксплуатируемых объектов. В качестве основы для предлагаемого решения была выбрана настольная издательская система LuaLaTeX, которая относится к свободно распространяемому программному обеспечению. Для достижения цели были использованы методы процедурного программирования языков: TeX и Lua. Предложенный способ позволяет минимизировать время внесения изменений в комплект руководств пользователей и обеспечить снижение вероятности появления в ней ошибок. Все перечисленное достигается посредством применения в предлагаемом решении концепции публикации из единого источника. Практическая значимость предлагаемого решения заключается в минимизации трудоемкости процесса поддержания в актуальном состоянии комплекта руководств по эксплуатации для семейств эксплуатируемых объектов.

Ключевые слова: руководство по эксплуатации, семейство эксплуатируемых объектов, концепция публикации из единого источника, LuaLaTeX.

Для цитирования: Полищук, Ю. В., & Гончарова, Я. В. (2023). Автоматизация процесса формирования комплекта руководств по эксплуатации для семейств эксплуатируемых объектов. Современные инновации, системы и технологии - Modern Innovations, Systems and Technologies, 3(4), 0332-0341. https://doi.org/10.47813/2782-2818-2023-3-4-0332-0341

Automation of the process of generating a set of manuals for

families of operated objects

Yu. V. Polischuk, Ya. V. Goncharova

Moscow Technical University of Communications and Informatics, Moscow, Russia

Abstract. As part of this work, a method is proposed to automate the process of generating a set of operating manuals for families of operated objects. The desktop publishing system LuaLaTeX, which is freely distributed software, was chosen as the basis for the proposed solution. To achieve the goal, methods of procedural programming languages were used: TeX and Lua. The proposed method allows us to minimize the time it takes to make changes to a set of user manuals and reduce the likelihood of

© Полищук Ю. В., Гончарова Я. В., 2023

0332

errors appearing in it. All of the above is achieved through the application of the concept of publishing from a single source in the proposed solution. The practical significance of the proposed solution lies in minimizing the labor intensity of the process of maintaining an up-to-date set of operating manuals for families of operated objects.

Keywords: manual, family of exploitable objects, single source publishing concept, LuaLaTeX.

For citation: Polischuk, Y. V., & Goncharova, Y. V. (2023). Automation of the process of generating a set of manuals for families of operated objects. Modern Innovations, Systems and Technologies, 3(4), 0332-0341. https://doi.org/10.47813/2782-2818-2023-3-4-0332-0341

ВВЕДЕНИЕ

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

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

Таким образом, анализ принципов формирования документации вида руководства по эксплуатации семейств эксплуатируемых объектов является актуальной задачей исследования.

АНАЛИЗ ПРИНЦИПОВ ФОРМИРОВАНИЯ РУКОВОДСТВ ПО

ЭКСПЛУАТАЦИИ

Существует два основных способа формирования руководств по эксплуатации для семейства эксплуатируемых объектов. Рассмотрим их подробнее.

При формировании руководств по эксплуатации первым способом для всех эксплуатируемых объектов семейства формируется единое руководство по их эксплуатации. В этом случае основой для руководства являются общие для всего семейства особенности, которые дополнены особенностями конкретных модификаций объектов семейства.

В данной реализации после модернизации семейства эксплуатируемых объектов требуется внесение изменений в единое руководство по эксплуатации, а в процессе эксплуатации разных объектов семейства пользователи будут использовать единое руководство по эксплуатации (рисунок 1).

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

Figure 1. Schematic representation of user usage unified operating manual.

На рисунке 1 использованы следующие обозначения: N - общее количество условных пользователей, эксплуатирующих каждую из модификаций объектов семейства; N. - количество модификаций для эксплуатируемых объектов семейства.

Второй способ формирования руководств по эксплуатации для семейства эксплуатируемых объектов заключается в разработке уникального руководства по эксплуатации для каждой модификации эксплуатационного объекта семейства (рисунок 2).

Рисунок 2. Схематичное представление использования пользователями уникального руководства по эксплуатации.

Figure 2. Schematic representation of how users use the unique instruction manual.

На схематичном представлении (рисунок 2) использованы аналогичные обозначения, использованные в ранее рассмотренном схематичном представлении (рисунок 1).

В представленном способе модернизация семейств эксплуатируемых объектов потребует внесения изменений во все руководства по эксплуатации, что при ручной реализации данного процесса существенно усложняет данную задачу, а в процессе

эксплуатации разных объектов семейства пользователи будут использовать соответствующий вариант руководства по эксплуатации.

Сравним особенности рассмотренных способов формировании руководств по эксплуатации для семейств эксплуатируемых объектов. Для этого выделим их основные технико-эксплуатационные характеристики (таблица 1).

Таблица 1. Сравнение технико-эксплуатационных характеристик способов формирования руководств по эксплуатации для семейств эксплуатируемых объектов.

Table 1. Comparison of technical and operational characteristics of methods for generating operating manuals for families of operated objects.

№ Характеристика Способ формирования

Единый Уникальный

1 Отсутствие избыточной информации - +

2 Минимизация расходов на публикацию - +

3 Минимизация массо-габаритных характеристики руководств по эксплуатации - +

4 Минимизация трудозатрат на создание и модификацию + -

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

Отсутствие избыточной информации в руководстве по эксплуатации позволяет сократить его объем, а также минимизировать массогабаритные характеристики и стоимость публикации.

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

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

МЕТОДЫ

Минимизация трудозатрат на создание и модификацию уникальных руководств по эксплуатации может быть достигнута за счет их автоматизированного создания из единого руководства посредством удаления фрагментов, не относящихся к объекту, для

которого формируется руководство, а при необходимости модернизации руководств по эксплуатации семейства эксплуатируемых объектов все изменения выполняются в едином руководстве по эксплуатацию, а формирование уникальных руководств по эксплуатации для каждого варианта эксплуатируемого объекта выполняется автоматизировано.

Предложенное решение соответствует направлению концепции публикации из единого источника (Single Source Publishing) [1,2].

Схематичное представление предлагаемого решения приведено на рисунке 3.

Пользователь

Руководство по эксплуатации № 1

О © 3

© © 6

© 8 ... ,,

I I I I I I I I I I I

Руководство по эксплуатации №2 © © 3

© 5 ©

© 8 . . N

I I

Руководство по эксплуатации J№No

О © 3

W © 6

7 © .

Рисунок 3. Схематичное представление предлагаемого решения. Figure 3. Schematic representation of the proposed solution.

ПРАКТИЧЕСКАЯ РЕАЛИЗАЦИЯ

Для практической реализации может быть использована настольная издательская система LuaLaTeX, которая является модификацией издательской системы LaTeX [3]. Система LuaLaTeX поддерживает весь функционал LaTeX и в дополнение реализует такие полезные возможности как подключение внешних шрифтов ttf и интеграцию скриптов Lua.

Обе указанные системы обладают высокой стабильностью работы и мощным расширяемым функционалом. Стоит отметить, что они применяются для решения задач по оформлению и генерации различных видов документации, в том числе, автоматизировано [4,5].

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

Для понимания данного процесса рассмотрим пример автоматизированной разработки комплекта руководств по эксплуатации для четырех модификаций автомобиля, которые представлены следующим набором маркеров:

- d20l - дизельный двигатель, объем 2.0 литра, левый руль;

- d20r - дизельный двигатель, объем 2.0 литра, правый руль;

- g16tl - бензиновый турбо двигатель, объем 1.6 литра, левый руль;

- g16tr - бензиновый турбо двигатель, объем 1.6 литра, правый руль.

Выделение отдельного маркера для характеристики расположения руля позволяет

сократить количество рисунков, так как в документации приводятся отдельные изображения для каждого из вариантов.

Рассмотрим демонстрационный результат формирования одной из таблиц документации для модификаций с маркерами d20l и g16tl (рисунок 4).

Версия документа -1(1201|.

Техническое обслуживание в неблаюнршпнмх условиях эксплуатации и при малом пробеге (для Европы)

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

И: сменить или заменить.

I: проверить и при необходимости отрегулировать, отрсмонти ровать, очистить или заменить.

Операции технического обслуживании Операция обслуживания Периодичность техобслуживании Условия движения

Моторное масло и фильтр R Через каждые 15 000 км пробега или 12 месяцев эксплуатации А, В, С, D, E, F, G, H, I, .Г, К, L

Фильтр воздухоочистителя R Заменять чаще в зависимости От состояния С, К

Версия документа -

Техническое обслуживание в неблагоприятных условии? эксплуатации п при малом пробеге (для Европы)

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

Я: сменить или заменить.

I : проверить и при необходимости отрегулировать, отремонти ровать, очистить или заменить.

Операции тех- Операции об- Периодич- Условии дви-

нического об- служивания ность техоб- жения

служивания служивании

Моторное мас- R Каждые А, В, С, D. E, F,

ло и фильтр 7500 км или 6 месяцев G, H, I. J, К. L

Фильтр возду- R Заменять чаще С, Е

хоочистителя в зависимости от состояния

Тестовая стро- - - -

ка для gl6tl &

glôtr

Тестовая строка для gl6tl & glôtr

Рисунок 4. Результат формирования документации для модификаций

с маркерами d20l и g16tl.

Figure 4. The result of generating documentation for modifications with markers d20l and

g16tl.

Полученный результат достигается посредством следующего кода (рисунок 5.)

% задание маркера %\newcommand{\layer} {|d20l |} \newcommand{\layer}{|g16tl|}

\noindent\begin{tabularx}{\linewidth}{|X|X|X|X|}% use \linewidth \hline

\textbf{Операции технического обслуживания} & \textbf{Операция обслуживания} &

М£хЛДПериодичность техобслуживания} & \textbf{Условия движения} \\

\hline

Моторное масло и фильтр & R &

\directlua{printtexfile(\luastring{\layer},"|g16tl|g16tr|","g16tl_g16tr_1.tex")}\directlua{prin ttexfile(\luastring{\layer},"|d20l|d20r|","d20l_d20l_1.tex")} & A, B, C, D, E, F, G, H, I, J,

K, L \\ \hline

Фильтр воздухоочистителя & R & Заменять чаще в зависимости от состояния & C, E

\\

\hline

\directlua{printtexfile(\luastring{\layer},"|g16tl|g16tr|","g16tl_g16tr_2.tex")} \end{tabularx}_

Рисунок 5. Исходный код для документации. Figure 5. Source code for documentation.

Проверку включения фрагмента в контент в соответствии с текущим маркером реализует функция printtexfile, которая имеет три входных параметра: текущий маркер; перечень маркеров, соответствующих фрагменту; название файла, в котором хранится фрагмент. Функция printtexfile реализована на языке Lua.

ЗАКЛЮЧЕНИЕ

Предложенный в работе способ автоматизации формирования руководств по эксплуатации для семейств эксплуатируемых объектов базируется на настольной издательской системе LuaLaTeX, работает для всех пакетов системы LaTeX 2s и не требует применения дополнительного программного обеспечения.

Применение данного способа реализует возможность качественной подготовки комплектов руководств по эксплуатации за счет издательской системы LaTeX, а функционал интегрированного языка Lua реализует концепцию публикации из единого источника. Последнее позволяет минимизировать время внесения изменений в комплект руководств по эксплуатации, а также обеспечивает снижение вероятности появления в нем ошибок.

СПИСОК ЛИТЕРАТУРЫ

[1] Дмитриев П.И. Автоматизация процесса формирования комплектов технической документации на основе онтологического подхода. Информация и космос. 2011; 1: 9093.

[2] Полищук Ю.В., Черных Т.А. О способах реализации концепции единого источника. Информационные технологии. 2014; 7: 37-41.

[3] Еремин М. В. Обзор системы для подготовки документов LaTeX. Тенденции развития науки и образования. 2022; 87-1: 58-61. https://doi.org/10.18411/trnio-07-2022-12

[4] Вольнов Е.В. Использование издательской системы LaTeX для оформления диссерта-ций. Медицинский альманах. 2022; 4(73): 110-124.

[5] Полищук Ю.В. Способ синтеза интерактивных образовательных ресурсов формата PDF с применением LuaLaTeX. Программные продукты и системы. 2023; 2: 281-285. https://doi.org/10.15827/0236-235X.142.281-285

REFERENCES

[1] Dmitriev P.I. Avtomatizaciya processa formirovaniya komplektov tekhnicheskoj

dokumentacii na osnove ontologicheskogo podhoda. Informaciya i kosmos. 2011; 1: 90-93.

[2] Polishchuk Yu.V., Chernyh T.A. O sposobah realizacii koncepcii edinogo istochnika. Informacionnye tekhnologii. 2014; 7: 37-41.

[3] Eremin M. V. Obzor sistemy dlya podgotovki dokumentov LaTeX. Tendencii razvitiya nauki i obrazovaniya. 2022; 87-1: 58-61. https://doi.org/10.18411/trnio-07-2022-12

[4] Vol'nov E.V. Ispol'zovanie izdatel'skoj sistemy LaTeX dlya oformleniya disserta-cij. Medicinskij al'manah. 2022; 4(73): 110-124.

[5] Polishchuk Yu.V. Sposob sinteza interaktivnyh obrazovatel'nyh resursov formata PDF s primeneniem LuaLaTeX. Programmnye produkty i sistemy. 2023; 2: 281-285. https://doi.org/10.15827/0236-235X.142.281-285

ИНФОРМАЦИЯ ОБ АВТОРАХ / INFORMATION ABOUT THE AUTHORS

Полищук Юрий Владимирович, доктор технических наук, доцент, Московский технический университет связи и информатики, Москва, Россия

Гончарова Яна Владимировна,

Московский технический университет связи и информатики, Москва, Россия

Yuri Polishchuk, Doctor of Technical Sciences, Associate Professor, Moscow Technical University of Communications and Informatics, Moscow, Russia

Yana Goncharova, Moscow Technical University of Communications and Informatics, Moscow, Russia

Статья поступила в редакцию 07.11.2023; одобрена после рецензирования 17.11.2023; принята

к публикации 20.11.2023.

The article was submitted 07.11.2023; approved after reviewing 17.11.2023; accepted for publication

20.11.2023.