CC BY
85
УДК 004.4 Дата подачи статьи: 28.02.17
DOI: 10.15827/0236-235X.030.3.504-509 2017. Т. 30. № 3. С. 504-509
АВТОМАТИЗАЦИЯ ПРОЦЕССОВ ПОДГОТОВКИ ПРОГРАММНОЙ ДОКУМЕНТАЦИИ НА ИЗДЕЛИЯ РАДИОЭЛЕКТРОННОЙ ПРОМЫШЛЕННОСТИ
А.В. Гурьянов, генеральный директор, postmaster@eelavt.spb.ru (ОКБ «Электроавтоматика», ул. Маршала Говорова, 40, г. Санкт-Петербург, 198095, Россия); А.В. Шукалов, к.т.н., доцент, aviation78@mail.ru; И.О. Жаринов, д.т.н.., доцент, зав. кафедрой, igor_rabota@pisem.net; М.О. Костишин, к.т.н., доцент, maksim@fcostishin.com; С.А. Леоновец, аспирант, ser2694@ya.ru (Санкт-Петербургский национальный исследовательский университет информационных технологий, механики и оптики, Кронверкский просп., 49, г. Санкт-Петербург, 197101, Россия)
Рассматривается научная задача автоматизации подготовки текстовой программной документации с помощью специализированного программного средства.
Автоматизация процесса подготовки документации основана на обработке данных, содержащихся в нормативно-технической документации или в техническом задании. Обработка данных предполагает наличие структурированных электронных документов, подготовленных в распространенных форматах в соответствии с шаблонами на основе отраслевых стандартов, и генерацию автоматизированным способом текстового программного документа. Шаблоны могут меняться на любом этапе жизненного цикла проекта. Временные затраты на смену шаблона должны быть минимальными. Для их предварительного показа пользователю используется формат XPS.
Приведены в форме графа перечень разрабатываемых программных документов и пример обработки данных для генерации текстового документа, созданного на основании ГОСТ 19.101-77. Описаны новое разработанное ПО и инструментальные средства, доступные разработчику в проектной деятельности на приборостроительном предприятии. Показан пример изменения состояния атрибутов документов, а также приведен алгоритм создания проекта программного документа в разработанном ПО.
Разработка системы автоматизации оформления технической документации является экономически выгодной. Предлагаемая программа САПР позволяет автоматизировать на приборостроительном предприятии работу разработчиков программно-управляемых изделий, связанную с подготовкой программной документации.
Программное средство разработано и функционирует на базе инструментальной ЭВМ с характеристиками: процессор Intel(R) Core(TM) i5-6300HQ, 4 ядра, тактовая частота 2,3 ГГц, оперативная память 8 Gb под управлением операционной системы Windows 7.
Ключевые слова: программная документация, автоматизация, текстовые документы, генерация.
Процесс разработки программно-управляемых изделий сопровождается подготовкой программной документации (ПД) на различных этапах проектирования: эскизное проектирование, технический проект, технические предложения, рабочее конструкторское проектирование. Номенклатура разрабатываемых документов регламентируется соответствующими государственными стандартами, в частности ГОСТ 19.101-77, и зависит от сложности программы (компонента, комплекса) и области ее применения.
В арсенале разработчиков ПД сегодня имеются различные программные средства, автоматизирующие процесс ее подготовки. Широкое практическое применение получили системы 3SL Cradle 7.0 и ДС БАРС КТ-178В, предназначенные для контроля жизненного цикла ПО, а также текстовый процессор Word, используемый для оформления текстовой документации, и т.д. [1-4].
Основной особенностью применения таких программных средств является их узкая специализация, обеспечивающая разработчику возможность автоматизировать процесс подготовки ограниченного числа видов ПД в отрыве от общего числа до-
кументов, разрабатываемых на проект в целом. Таким образом, разработчики вынуждены устанавливать на инструментальную ЭВМ автоматизированного рабочего места (АРМ) различные виды САПР и оформлять техническую документацию проекта поочередно - сначала одну группу ПД с использованием одного вида САПР, затем другую группу ПД с использованием другого вида САПР и т.д. При этом эффективность автоматизации процесса разработки ПД от применения САПР резко снижается и в ряде случаев взаимосвязь между данными, являющимися составной частью различных документов, оказывается сосредоточенной только в памяти разработчика, что создает предпосылки для возникновения ошибок проектирования.
В связи с этим актуальной является задача разработки отраслевых САПР, позволяющих разработчикам осуществлять автоматизированную поддержку процесса сквозного проектирования ПД на программу. Основные методологические аспекты построения отраслевой САПР в области авиаприборостроения приведены в [5-10]. Цель настоящей статьи - представить широкому кругу читателей результаты исследований, направленных на разра-
ботку инструментального средства, реализуемого программным способом, для автоматизированного формирования взаимосвязанных текстовых программных документов на основе обработки данных проекта.
Номенклатура разрабатываемых ПД
Основополагающим общетехническим документом, который регулирует на предприятии отношения заказчика (военного представителя) и разработчика в части объема и видов ПД, разрабатываемых на программно-управляемое изделие на определенном этапе проектирования, является протокол номенклатуры ПД. В нем указывается следующее: исчерпывающий перечень ПД, подготавливаемых на программу; используемые при этом САПР, включая версии ПО, установленные на инструментальной ЭВМ АРМ; подразделения - ответственные исполнители по разработке и согласованию (метрология, нормоконтроль, технологический контроль и т.д.) ПД; способ (электронный, на бумажных носителях) и сроки хранения документации в архиве предприятия.
На рисунке 1 приведен граф ПД (пример), разрабатываемых на программно-управляемое изделие. Стрелками схематично показаны взаимосвязи между документами - данные, являющиеся исходными для подготовки пошагово разрабатываемых видов ПД.
Рис. 1. Граф ПД, разрабатываемых на программно-управляемое изделие (пример)
Fig. 1. A program documentation graph developed for software-controlled product (example)
На рисунке 1 используются обозначения, принятые в отраслевых стандартах для определения различных кодов ПД: 12 - текст программы, 13 -описание программы, 20 - ведомость эксплуатационных документов, 30 - формуляр, 31 - общее описание, 32 - руководство системного программиста, 33 - руководство программиста, 34 - руководство
оператора, 35 - описание языка, 46 - руководство по техническому обслуживанию, 51 - порядок и методика испытаний, 81 - пояснительная записка, ТЗ - техническое задание, Е1 - схема деления изделия на составные части. Взаимосвязи программных документов показаны стрелками.
Описание инструментального средства проектирования взаимосвязанных ПД
Инструментальное средство проектирования взаимосвязанных ПД представляет собой программный продукт, интерфейс пользователя которого показан на рисунке 2. Программа написана на объектно-ориентированном языке программирования высокого уровня C#, на платформе .NET Framework 4 с использованием встроенной презентационной графической подсистемы для построения клиентских приложений WPF. В качестве средства разработки использована интегрированная среда разработки Microsoft Visual Studio 2015 Professional Edition В рабочем окне программы отображаются дерево разрабатываемого проекта (1), рабочая область окна предварительного просмотра (2), рабочая область окна редактирования (3), меню разработчика (4), панель инструментов разработчика (5) и строка состояния процесса проектирования (6).
Дерево разрабатываемого проекта представляет собой удобный для навигации по проекту программный инструмент, в котором отображаются нормативно-техническая документация, необходимая для генерации программной документации, документы служебной переписки разработчика и заказчика, а также разрабатываемые ПД.
Перечень разрабатываемых ПД сопровождается в рабочем окне программы указанием на их верси-онную принадлежность для каждого документа и состоянием разработки. Единица конфигурации (ЕК, configuration item, CI) - данные жизненного цикла, которые в целях управления конфигурацией рассматриваются как единое целое. В качестве ЕК документ имеет следующие обязательные атрибуты:
- уникальный идентификатор, не изменяемый в процессе жизненного цикла и позволяющий идентифицировать изменение документа на всем его протяжении; используется GUID;
- версия, состоящая из двух натуральных чисел (старшая и младшая части номера версии), увеличивающихся при начале изменения документа; старшая часть отражает номер базовой версии (в случае утверждения документа), младшая - номер редакции в процессе подготовки базовой версии;
- имя - строка, название документа;
- дата и время последнего изменения;
- состояние - одно из значений: «черновик» (draft), «проверка» (proposed), «утверждено» (approved), «отклонен» (declined).
Рис. 2. Вид диалогового окна программы проектирования взаимосвязанных ПД Fig. 2. A dialog window of a design program of interrelated software documentation
На рисунке 3 представлена схема взаимодействия изменяемых и постоянных атрибутов ЕК.
Дерево проекта, представленное на рисунке 2, программно реализовано от API-функции (applica tion programming interface) System.Windows.Con-trols.TreeView операционной системы Windows инструментальной ЭВМ АРМ. Каждый вид элемента разрабатываемого ПД представлен соответствующим видом ярлыка в рабочем окне программы в рабочем поле (1).
Рабочая область окна предварительного просмотра (2) позволяет разработчику оценивать содержание и оформление ПД при его автоматизированной генерации. Инструментальные средства САПР позволяют разработчику просматривать проект документа (режим предварительного про-
смотра) перед его сохранением на диске и при необходимости распечатать его на бумажный носитель. Реализовано несколько полезных возможностей:
- поиск текста в конструкторском документе по ключевым словам, заданным в строке поиска;
- масштабирование документа для удобства его предварительного просмотра.
Меню разработчика (4) в рабочем окне программы, показанном на рисунке 2, представлено следующими опциями.
• «Проект». Включает стандартные функции для работы с текущим проектом (создание нового проекта, загрузка существующего проекта из дискового накопителя, сохранение внесенных изменений в проекте). Опция позволяет выбрать шаблон документа, созданный на предприятии на основе требований отраслевых стандартов, а также сохранять документ на диске инструментальной ЭВМ АРМ в универсальном формате XML (eXtensible Markup Language) для поддержки просмотра и редактирования документа в стандартных текстовых редакторах.
• «Конфигурация». Включает функции для создания разработчиком конфигурации атрибутов элементов ПД, зависящих от типа документа и соответствующей нормативно-технической документации. Атрибуты документа могут быть одного из следующих типов: произвольный текст, список из нескольких элементов, который формирует разработчик конфигурации, логическое значение.
Постоянные атрибуты GUID, имя
v1.0 status-approved дата изменения
v2.1 status-draft дата изменения
v2.2 status-approved дата изменения
Рис. 3. Постоянные и изменяющиеся атрибуты программного документа
Fig. 3. Constant and changing attributes of a software document
^ Начало^
Ï
Запуск САПР
• «Инструменты». Включает функции автоматизированного контроля соответствия документа требованиям нормативно-технической документации, а также функции генерации документа в формате текстового процессора Word.
• «Настройки». Подменю, где разработчику доступно изменение настроек функционирования рабочей программы, а именно: частота автосохранения проекта на диске инструментальной ЭВМ, язык интерфейса программы и т.д.
• «Поддержка». Включает подменю с формой для обращения разработчика в службу технической поддержки, организованную разработчиком САПР (при необходимости).
• «О программе». Содержит сведения о верси-онной принадлежности САПР.
Панели инструментов (5) разработчика позволяют разработчику получить быстрый доступ к наиболее часто используемым инструментальным средствам программы создания взаимосвязанных ПД.
Строка состояния (6) процесса проектирования представляет разработчику справочные данные и допускает следующие виды состояний программы: Ready (программа готова к использованию), Loading (загрузка проекта или документа), Generation (генерация ПД), Save (сохранение проекта на диске).
Пример использования шаблонов конструкторских документов
Программа разработки текстовой программной документации использует шаблоны оформления, основанные на требованиях нормативно-технической документации (отраслевые стандарты). Программа
предполагает подготовку отчетных текстовых документов в электронном виде в формате файлов dot или doc. Алгоритм процесса создания проекта с использованием программных шаблонов представлен на рисунке 4.
При генерации ПД пользователь может выбрать готовый шаблон или задать и сохранить свой собственный, по которому будет оформлен документ. Автоматически в документе формируются следующие элементы: титульный лист, содержание, таб-
Нет
Ввод имени
проекта +
Проверка введенного значения
1 гДа
Поиск проектов в БД и вывод пользователю
1 Г
Добавление проекта
в БД *
Поиск шаблонов формата *.dot или *.doc в пользовательской
Да
Нет
Генерация базового шаблона с использованием процедурного кода
-Нет
Сохранение шаблонов в формате *.xps для демонстрации пользователю
Сохранение шаблона в переменной templateProject
Проект готов к работе
ГкОНецЗ
Рис. 4. Алгоритм создания проекта ПД с использованием программных шаблонов
Fig. 4. The algorithm of creating a software documentation project using software patterns
лицы требований, колонтитулы, а также при необходимости специальные элементы (таблица квалификационных методов, матрица прослеживаемости и пр.).
Фрагмент кода программы, написанной на высокоуровневом языке программирования C#, который обрабатывает документ в формате dot, содержащий необходимый шаблон, представлен на рисунке 5.
Таким образом, в программе САПР реализована автоматизированная обработка структурированных электронных текстовых ПД с целью извлечения из них инженерных данных, используемых в ПД, разрабатываемых на последующих этапах проектирования.
Заключение
Разработка системы автоматизации оформления технической документации является экономически выгодной. Предлагаемая программа САПР позволяет автоматизировать на приборостроительном предприятии работу разработчиков программно-управляемых изделий, связанную с подготовкой программной документации.
Программа САПР имеет объективные преимущества перед известными программными продук-
тами аналогичного назначения, такими как 3SL Cradle 7.0 и ДС БАРС КТ-178В, за счет наличия встроенной опции контроля версий, позволяющей разработчику сопровождать изделия, разработанные по разным версиям ПД, в жизненном цикле продукции, и создавать архивные версии комплектов ПД в электронном виде.
Программное средство разработано и функционирует на базе инструментальной ЭВМ с характеристиками: процессор Intel(R) Core(TM) i5-6300HQ, 4 ядра, тактовая частота 2,3 ГГц, оперативная память 8 Gb под управлением Windows 7.
Литература
1. Авдеева М., Чир-кин А. Перевод бумажной документации в электронный вид // САПР и графика. 2004. № 1. С. 70-72.
2. Садовников Д., Ноздрин А., Ширяев Н. Система управления технической и проектно-конструкторской документацией // САПР и графика. 2002. № 5. С. 74-77.
3. Кукаренко Е., Молочко Д. Управление потоками знаний в техническом документообороте предприятия // САПР и графика. 2001. № 10. С. 35-37.
4. Бычков И., Ващук Ю. Конструкторская спецификация - информационная основа управления предприятием // САПР и графика. 2001. № 9. С. 90-95.
5. Брахутин А.Г. CALS выходит на федеральный уровень // Вестн. авиации и космонавтики. 2001. № 5. С. 26-27.
6. Богатырев В.А. Комбинаторно-вероятностная оценка надежности и отказоустойчивости кластерных систем // Приборы и системы. Управление, контроль, диагностика. 2006. № 6. С. 21-26.
7. Богатырев В.А. Надежность и эффективность резервирования компьютерных сетей // Информационные технологии. 2006. № 9. С. 25-30.
8. Парамонов П.П., Гатчин Ю.А., Жаринов И.О., Жари-нов О.О., Дейко М.С. Принципы построения отраслевой системы автоматизированного проектирования в авиационном приборостроении // Науч.-технич. вестн. информ. технологий, механики и оптики. 2012. № 6. С. 111-117.
9. Богатырев В.А., Богатырев С.В. Объединение резервированных серверов в кластеры высоконадежной компьютерной системы // Информационные технологии. 2009. № 6. С. 41-47.
10. Жаринов И.О., Жаринов О.О., Шек-Иовсепянц Р.А., Суслов В.Д. Оценка снижения трудоемкости подготовки конструкторской документации с использованием CALS-технологии в приборостроении // Науч.-технич. вестн. информ. технологий, механики и оптики. 2012. № 4. С. 151-153.
foreach (string nameDoc in Directory.GetFiles(MyDoc)) {
// Отсеиваем файлы, не являющиеся шаблонами
if (nameDoc.Remove(0, nameDoc.Length - 3) == "dot") {
// Сохранение в XPS для предпросмотра Word.Application oWord = new Word.Application(); Word.Document oDoc = oWord.Documents.Add(@nameDoc);
stringpathXPS = nameDoc.Remove(nameDoc.Length - 3) + "XPS"; object fileName = pathXPS;
object FileFormat = Word.WdSaveFormat.wdFormatXPS; object oMissing = System.Reflection.Missing. Value;
oWord.ActiveDocument.SaveAs(reffileName,
ref FileFormat, ref oMissing, ref oMissing, ref oMissing, ref oMissing, ref oMissing, ref oMissing, ref oMissing, ref oMissing, ref oMissing, ref oMissing, ref oMissing, ref oMissing, ref oMissing, ref oMissing);
oDoc. Close(Word. WdSaveOptions.wdDoNotSaveChanges); oWord.Quit();
string nameShort = nameDoc.Remove(nameDoc.Length - 4).Remove(0, MyDoc.Length); //Вызов метода, рисующего панель
CreateTemplateView(nameDoc, pathXPS, nameShort); }
}
Рис. 5. Фрагмент кода программы Fig. 5. A fragment of a program code
Software & Systems
DOI: 10.15827/0236-235X.030.3.504-509
Received 28.02.17 2017, vol. 30, no. 3, pp. 504-509
AUTOMATIZATION OF SOFTWARE DOCUMENTATION PREPARATION PROCESSES FOR RADIO-ELECTRONICS INDUSTRY DEVICES
A. V. Guryanov 1, Director General, postmaster@elavt.spb.ru
A. V. Shukalov 2, Ph.D. (Engineering), Associate Professor, aviation78@mail.ru
I.O. Zharinov 2, Dr.Sc. (Engineering), Associate Professor, Head of Chair, igor_rabota@pisem.net
M.O. Kostishin 2, Ph.D. (Engineering), Associate Professor, maksim@kostishin.com
S.A. Leonovets 2, Postgraduate Student, ser2694@ya.ru
1 Design Bureau "Electroavtomatika", Marshala Govorova Str. 40, St. Petersburg, 198095, Russian Federation
2 The National Research University of Information Technologies, Mechanics and Optics, Kronverksky Ave. 49, St. Petersburg, 197101, Russian Federation
Abstract. The paper considers a scientific task of automated preparation of text software documentation using a specialized software.
Automation of the process of document preparation is based on data processing from specifications and technical documentation or in the specification. Data processing assumes availability of structured electronic documents prepared in widespread formats according to templates on the basis of industry standards and generation by the automated method of the textual program document. Templates can change at any stage of a project lifecycle. Time expenditure on a template change shall be minimum. Their preview to the user is in the XPS format.
The paper provides a list of the developed software documents and the example of data processing to generate a textual document as a graph. The textual document is created based on the state standard 19.101-77. The paper describes a new developed software and tools that are available to a developer in project activities at the instrument-making entity. There is the example of changing a condition of attributes of documents. There is also the algorithm of creating a software document draft in the developed software.
The development of a system for automating the registration of technical documentation is cost-effective. The proposed CAD program allows automating the work of software-controlled product developers related to program documentation preparation in an instrument-making enterprise.
The software is developed and functions based on a computer with characteristics: Intel (R) Core (TM) i5-6300HQ processor, 4 cores, 2.3 GHz clock speed, 8 Gb RAM, Windows 7.
Keywords: program documentation, automatization, text document, generating.
1. Avdeeva M., Chirkin A. Conversion of paper documents into electronic format. SAPR i grafika [CAD and Graphics]. 2004, no. 1, pp. 70-72 (in Russ.).
2. Sadovnikov D., Nozdrin A., Shiryaev N. Control system for technical and design documentation. SAPR i grafika [CAD and Graphics]. 2002, no. 5, pp. 74-77 (in Russ.).
3. Kukarenko E., Molochko D. Managing Knowledge Flows in an Enterprise Technical Document Workflow. SAPR i grafika [CAD and Graphics]. 2001, no. 10, pp. 35-37 (in Russ.).
4. Bychkov I., Vashchuk Yu. Design specification is the information basis of enterprise management. SAPR i grafika [CAD and Graphics]. 2001, no. 9, pp. 90-95 (in Russ.).
5. Brakhutin A.G. CALS rises to the federal level. Vestn. aviatsii i kosmonavtiki [Aerospace Herald]. 2001, no. 5, pp. 26-27 (in Russ.).
6. Bogatyrev V.A. The combinatorial stochastic method of reliability evaluation and fault tolerance for networks with cluster architecture. Pribory i sistemy. Upravlenie, kontrol, diagnostika [Instruments and Systems: Monitoring, Control, and Diagnostics]. 2006, no. 6, pp. 21-26 (in Russ.).
7. Bogatyrev V.A. Reliability and Efficiency Reservations of Computer Networks. Informatsionnye tekhnologii [Information Technologies]. 2006, no. 9, pp. 25-30 (in Russ.).
8. Paramonov P.P., Gatchin Yu.A., Zharinov I.O., Zharinov O.O., Deyko M.S. Principles of constructing a branch system of computer-aided design in aircraft instrument making. Nauch.-tekhnich. vestn. inform. tekhnology, mekhaniki i optiki [Scientific and Technical Journal of Information Technologies, Mechanics and Optics]. 2012, no. 6, pp. 111-117 (in Russ.).
9. Bogatyrev V.A., Bogatyrev S.V. Association Reservation Servers in Clasters Highly Reliable Computersystem. Informatsionnye tekhnologii [Information Technologies]. 2009, no. 6, pp. 41-47 (in Russ.).
10. Zharinov I.O., Zharinov O.O., Shek-Iovsepyants R.A., Suslov V.D. Assessment of labor intensity reduction when preparing design documentation using CALS-technology in instrument engineering. Nauch.-tekhnich. vestn. inform. tekhnology, mekhaniki i optiki [Scientific and Technical Journal of Information Technologies, Mechanics and Optics]. 2012, no. 4, pp. 151-153 (in Russ.).
References
