Автоматизация технического документирования
А.В. Заболеева-Зотова, Н.Ю. Миляев
Волг.ГТУ
Современные источники информации не всегда отвечают предъявляемым к ним требованиям по удобству обработки представляемых данных и информативности. Особенно это относится к технической документации, уровень которой в последнее время заметно отстает от уровня развития техники и технологии. Это связано, в первую очередь, с резко возросшим числом технических устройств, требующих описания, а во-вторых, с тем, что технология создания подобных документов не претерпела серьезных изменений с “дедовских” времен, когда любая документация просто печаталась на машинке. В то же время без качественной, грамотной и корректной документации невозможно эффективное изучение и использование "плодов цивилизации".
Для облегчения процесса создания технической документации, повышения ее качества, возникла новая отрасль в индустрии программного обеспечения – так называемые «Технические писатели» - системы, облегчающие процесс создания и корректировки технической документации. Подобные системы также называют «АРМ (автоматизированное рабочее место) технического писателя». Рынок подобных продуктов в настоящее время очень быстро развивается, особенно на Западе, в то время как в СНГ он только «становится на ноги».
Большинство подобных систем, созданных к настоящему моменту, выполняют лишь вторичную обработку документа: редактирование орфографии, стилистики, отступов и разметки страницы, коррекцию структуры документа. Существующие системы машинного перевода с иностранных языков можно отнести к средствам формирования первичного текста документа лишь условно, и только закрывая глаза на невысокое качество получаемого после перевода источника. Составление же собственно текста документа, как и в начале века, всецело ложится на плечи человека, пишущего документацию к техническому устройству (комплексу).
Специалист, занимающийся техническим писательством, должен владеть как основами лингвистических знаний, так и знаний компьютерных технологий, а также специальными методами описания технических систем. Нами разработан и апробирован примерный учебный план для профессиональной подготовки специалистов по данному направлению на базе высшего технического или высшего гуманитарного образования.
В целях организации обучения и автоматизации поддержки дальнейшей профессиональной деятельности специалистов по техническому документированию, нами разрабатывается автоматизированное рабочее место технического писателя “АРМТП”, включающее в себя универсальную оболочку и предметно-ориентированный репозиторий.
Разрабатываемая система, имеет основной своей целью создание непосредственно первоисточника технического документа, причем, используемые в данном АРМ методы и подходы позволяют получать текст документа, корректный с точки зрения русского языка и имеющей «правильную» с точки зрения технического документа структуру (нумерацию пунктов, отступы и.д.).
Кроме того, применяемые подходы позволяют получить некоторые дополнительные преимущества, например, возможность быстрого получения мультиязычных инструкций или получения различных методов рубрикации пунктов документа (например, можно получать инструкции, пункты которых содержат либо описание элементов устройства, либо последовательность действий над ними).
Данный АРМ предназначен как для создания проектных документов (техническое задание, технический проект, рабочий проект), так и для создания документов, которые описывают функционирование технических систем : руководства пользователя, руководства по эксплуатации, технологические регламенты, и т.п.
Для создания описания технического объекта применена объектно-ориентированная технология. При этом принята следующая иерархия понятия “технический объект”:
|
Функции выполняемые (над) подобъектами |
|
Свойства элементарных объектов |
|
Элементарные объекты (подобъекты) |
|
Технический объект |
Процесс формирования инструкции к некоторому техническому объекту можно представить как описание всех свойств составляющих его элементарных объектов и их взаимосвязей между собой. На первый взгляд такой способ создания документации кажется излишне сложным и трудоемким. Однако следует учесть, что схожие технические объекты (например, телевизоры одного поколения), имеют много одинаковых или похожих узлов. Один раз описав типовые элементы и занеся их в репозиторий, можно затем использовать их при описании конкретного устройства, корректируя лишь некоторые из их связей и свойств, получая при этом значительный выигрыш в скорости и удобстве формирования документа.
Процесс создания документации с использованием данного АРМ состоит из следующих стадий:
|
Описание системы с использованием репозитория |
|
Формирование репозитория |
|
Согласование лексем |
|
Трансляция документа |
На выходе блока согласования лексем получается готовый документ, корректный с точки зрения русского языка. Причем последние две стадии выполняются автоматически. От пользователя, в случае наличия заполненного репозитория, требуется выполнить лишь этап описания системы.
В конкретной реализации «АРМ технического писателя» описание объекта, его элементов, функций и взаимосвязей представлены в виде таблиц данных Paradox, а интерфейсная часть выполнена с использованием соответствующих элементов манипулирования данными. Cтруктура описания объектов и их взаимосвязей реализованы одноименными таблицами баз данных, поля в которых представляют соответствующие элементы.
Главное окно системы содержит интерфейсные элементы, позволяющие описывать элементы системы, происходящие с ними события и условия протекания событий. С помощью главного и выпадающих меню возможно вызывать для редактирования и справки различные словари: введений, типовых событий и элементов, контекстов и условий протекания событий. Можно легко добавлять объекты, свойства и события в репозиторий и из него.
После завершения формирования описания объекта, выбрав меню “Проект - Компилировать”, проводится компиляция документа и согласование лексем. В результате получается готовый текст документа, с согласованными лексемами, правильной структуры.