Механизм заимствования модулей данных

механизм заимствования модулей данных

(инженер-программист 1 кат.)

(ведущий инженер)

(ОАО "Концерн "ЦНИИ "Электроприбор")

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

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

- официальное полное наименование;

- номер версии, дата выпуска или другие данные, идентифицирующие конкретное состояние предмета документирования, которое будет зафиксировано в документации.

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

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

Проблема, описанная выше, решается путем автоматизации процессов разработки технической документации. Актуальным в настоящее время является применение модульного принципа [1,2]. Суть принципа в том, что он позволяет разработчикам создавать составные документы из многократно используемых фрагментов (модулей данных), хранящихся в единой базе данных. База данных, вне зависимости от ее технической реализации содержит, все модули данных, которые могут быть включены в разрабатываемые документы. Объем модуля данных определяется его предполагаемой функцией, фрагментом может быть целая глава, а может одна таблица. Обычно от модулей данных, несущих одну функцию, требуют единообразной структуры. Для каждого модуля в единой базе данных должна храниться ровно одна копия (обычно, справедливо до уровня проекта в единой базе данных). Модуль данных имеет уникальный идентификатор (код модуля данных). В конкретной статье рассматривается единая база данных в которой модули данных представляют из себя XML-файлы.

Эффективность подхода в первую очередь зависит от максимального уровня многократного использования компонентов документа. Для увеличения процента заимствования в модули данных вводится динамические объекты. Эти объекты – XML-теги имеющие вариативность значений в зависимости от набора заранее известных критериев.

Основные критерии:

- Заказчик;

- Комплектность;

- Модификация.

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

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

Пример формирования руководства по приложениям, имеющим параллельные версии для разных аппаратных платформ и операционных систем, приведен на Рисунке 1.

Рисунок 1 Использование применяемости модулей данных

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

Кроме того, возможны случаи полной или частичной идентичности отдельных МД для различных, как правило, родственных, изделий. В случае полного совпадения МД возможно прямое применение известного, например, по [3] механизма использования псевдонимов, состоящего в сопоставлении одному МД двух и более различных адресов (кодов МД), при этом физически в базе будет храниться только одна копия содержательной части МД. В случае использования псевдонимов редактированию подлежит только один, родительский МД, а дочерние являются его репликами. Если полное совпадение МД в определенный момент становится невозможным, связь с псевдонимом можно разорвать, но при этом завершится и автоматическая синхронизация документов, в которые входит МД.

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

Теги обращения к внешним ресурсам могут получать информацию непосредственно из базы данных, т. к. и исходный МД, и его клон обладают группами кода, однозначно определяющими их принадлежность к комплектам документации на соответствующее изделие в соответствующем исполнении [5]. Обозначение изделия совпадает с его первой группой кода с точностью до взаимно однозначных соответствий. Так как код входит в реквизитную часть МД, способ трансляции значения тега обращения к внешним ресурсам и его структура известны. Исполнение изделия совпадает с последними цифрами второй группы кода. Задача в этом случае сводится к исключению отображения нулевого значения исполнения изделия.

Для трансляции наименования изделия в модуль данных можно воспользоваться комментарием к MI-коду, составленному следующим образом: <наименование изделия на русском языке> <разделитель> <наименование изделия на английском языке> при печати в документ значения до или после разделительного символа в зависимости от языка модуля данных (однозначно определяется кодом модуля данных).

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

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

Рассматривались статистические данные по эксплуатационной документации нескольких групп изделий. При этом документы были разделены на три группы: инструкции и руководства по эксплуатации (документы, формализованные ГОСТ по содержанию, но не по контенту), формуляры и паспорта (документы, полностью регулируемые ГОСТ) и ведомости (краткие табличные документы, содержащие общие сведения об изделии), которым были приписаны эмпирические веса в соответствии с их вкладом в трудоемкость разработки.

Введены следующие параметры:

коэффициент заимствования, Кз= (100 – Wnew) и

относительная трудоемкость разработки документации (формула выведена эмпирическим путем):

, где

Wnew – доля новых МД с учетом веса документа;

Wмпп – доля заимствуемых МД с учетом параметризации;

Wмп – доля заимствуемых МД без учета параметризации;

ρi – вес документа i-го типа;

ρ1 – вес инструкций и руководств по эксплуатации (0.7);

ρ2 – вес формуляров и паспортов (0.25);

ρ3 – вес ведомостей (0.05).

При обработке статистических данных по изделиям получены следующие графики (рис. 2 – 4):

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

 

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

Данные по ведомостям не приводятся, так как их вклад в трудоемкость минимален, а состав не превышает 4 модулей данных.

 

Рисунок 4 Результаты обработки статистических данных для линейки изделий по относительной трудоемкости

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

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

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

1. Ralph Sprague Electronic Document Management: Challenges and Opportunities for Information System Managers // Management Information Systems Quarterly, pp. 29 – 49, March 1995

2. Davd J. Small A Model-Driven Architecture for Enterprise Document Management, Supporting Discovery and Reuse // The University of Leeds. School of Computer Studies. September 1999, 188 р.

3. S1000D International Specification for Technical Publication utilizing a common source database (Международная спецификация требований к техническим руководствам, выполняемым с использованием общей базы данных).

4. Joseph M. DeFee Business Performance Modeling for ERP Projects, Part 1, BPTrends January 2011

5. , Эффективное кодирование модулей данных и объектов мультимедиа при разработке технической документации // Вестник компьютерных и информационных технологий, №8, М, 2013, с. 22-28.