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

DOI:

2023 3(4) eISSN: 2782-2818

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

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

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

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

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

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

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

.

.

.

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

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

Пользователь №N u

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

I I

I I

...

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

Эксплуатируемый объект №1

Эксплуатируемый объект №2

Эксплуатируемый объект №N

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

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

Второй способ формирования руководств по эксплуатации для семейства эксплуатируемых объектов заключается в разработке уникального руководства по эксплуатации для каждой модификации эксплуатационного объекта семейства (рисунок 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.

Рисунок 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).

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

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

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

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

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

Версия документа — |gl 6tl|.

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

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

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

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

Операции технического обслуживания	Операция обслуживания	Периодичность техобслуживания	Условия движения
Моторное масло и фильтр	R	Через каждые 15 000 км пробега или 12 месяцев эксплуатации	А, В, С. D, Е, F, G, Н, 1, J, К, L
Фильтр воздухоочистителя	R	Заменять чаще в зависимости от состояния	С, Е

ювать, очистить или заменить
Операции технического об служивай ня	Операция обслуживания	Периодичность техоб служивания	Условия движения
Моторное масло и фильтр	R	Каждые 7500 км или 6 месяцев	А. В, С, D. Е, F, G, Н, 1, J, К, L
Фильтр воздухоочистителя	R	Заменять чаще в зависимости от состояния	С, Е
Тестовая с грека для g 1 6tl & g!6tr	—	—	—

Рисунок 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

\hline

\hline

\hline

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

Figure 5. Source code for documentation.

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

ЗАКЛЮЧЕНИЕ

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

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