Что такое проспект руководства по эксплуатации

Формирование требований к документации

   Схема кодирования МД

   Шаблоны типовых МД

   Шаблон структуры ЭЭД

   Словари терминов, сокращений, определений и используемых
стандартов

   Библиотека элементов оформления документации

Формирование плана-проспекта и планирование работ

Создание модулей данных

   Формирование текстово-графических МД

   Формирование электронных каталогов

Сопровождение документации

   Ведение электронного архива извещений

   Проведение изменений в модулях данных

   Выгрузка обновлений

В прошлом номере журнала были изложены основные понятия и принципы разработки
и сопровождения электронной эксплуатационной документации (ЭЭД). В данной статье
рассказывается о TGBuilder версии 2.3 — системе подготовки ЭЭД, которая позволяет
автоматизировать процесс создания ЭЭД.

В системе реализованы принципы и методики построения ЭЭД, изложенные в стандарте
AECMA1000D, разработанном Европейской ассоциацией производителей аэрокосмической
техники. Кратко обозначим его основные положения:

1. ЭЭД — это техническая информация, представленная как совокупность так называемых
   модулей данных (МД), каждый из которых имеет статусную (идентификационную)
   и содержательную части.
2. В ходе разработки документации создаваемые МД помещаются в общую базу данных
   (Common Source Data Base). При публикации документа из базы данных извлекается
   определенный набор МД, составляющих нужный документ в бумажной или электронной
   форме (Electronic Technical Publication).Такой документ в терминах указанного
   стандарта называют электронной публикацией. Комплект публикации составляет
   ЭЭД на изделие.

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

Формирование требований к документации

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

Схема кодирования МД

Как уже говорилось выше, у каждого модуля данных есть идентификационная (статусная)
и содержательная части. В статусную часть МД входят название и код модуля данных,
то есть его обозначение. Практически в любой публикации существует титульный
лист — в нашем случае это будет отдельный МД с названием «Титульный лист» и
уникальным кодом. Допустим, в других МД есть ссылки на МД «Титульный лист».
В системе TGBuilder для создания ссылок используется именно код МД, поскольку
при проведении изменений в документации может измениться и содержание МД «Титульный
лист», и его размер, и его структура, но код этого модуля останется тем же,
что и до проведения изменений. Таким образом, после проведения изменений в содержании
МД ссылки работают корректно.

Правила кодирования МД регламентированы стандартом AECMA1000D, где определены
вид и формат кода, то есть задана схема кодирования МД. Формализованное описание
схемы кодирования соответственно должно содержаться в шаблоне документации.
Рассмотрим пример формального описания схемы кодирования в системе TGBuilder.

Схема кодирования является шаблоном позиционного кода и может выглядеть, в частности,
следующим образом: YYY-XX-XX, где: символ Y — буква или цифра, символ X — цифра,
а символ «-» обозначает разделитель. Этот шаблон кода состоит из трех полей,
отделенных друг от друга разделителями. Несколько полей кода и разделителей
могут объединяться в сегмент кода. Схема кодирования МД может состоять из набора
сегментов, разделителей и полей кода.

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

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

Шаблоны типовых МД

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

Разработка шаблонов происходит следующим образом: основываясь на требованиях
стандартов, разрабатывается список типовых МД. Типы модулей данных по стандарту
AECMA1000D даны в табл. 1.

Общие типы МД, представленные в этой таблице, можно разделить на определенные
варианты и задать оформление для них. Например, модули типа «Описательная информация»
могут иметь следующие варианты:

• «Общие сведения»;
• «Устройство и работа»;
• «Технические характеристики».

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

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

Шаблон структуры ЭЭД

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

На рис. 2 приведен пример шаблона структуры «Руководства
по эксплуатации», построенного в соответствии с требованиями стандарта ГОСТ
2.601-95. «Руководство по эксплуатации» может состоять из семи разделов. В шаблоне
заранее проставлены их названия, последовательность и правила использования.
Например, раздел «Текущий ремонт» может отсутствовать в ЭЭД на конкретное изделие,
если это изделие не ремонтируется. Это свойство раздела отражено в шаблоне структуры
в виде модификатора .

В зависимости от правил использования при построении шаблона структуры применяются
модификаторы, представленные в табл. 2.

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

Словари терминов, сокращений, определений и используемых
стандартов

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

Библиотека элементов оформления документации

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

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

Формирование плана-проспекта и планирование работ

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

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

Создание модулей данных

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

• дата выпуска МД;
• язык;
• применяемость;
• прочие.

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

• текстовая и графическая информация;
• электронные каталоги.

В первый тип попадают все материалы, содержащие текст, графику, фрагменты мультимедиа.
Второй тип больше похож на хорошо знакомые электронные таблицы. Электронные
каталоги предназначены для хранения перечней многоразового использования каких-либо
объектов, например для хранения каталога деталей и сборочных единиц, ведомости
запчастей, инструментов и принадлежностей (ЗИП) и т.п. На элементы каталога
можно делать ссылки. Как и в бумажной версии каталога, в электронном каталоге
есть возможность организации каталожных карточек и настройки их визуального
оформления.

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

Формирование текстово-графических МД

Текстово-графические МД создаются в текстовом редакторе системы TGBuilder.
Хотя по общим принципам работы и возможностям этот редактор аналогичен редактору
MS Word, однако в нем есть ряд возможностей, существенно отличающих его от обычного
текстового редактора. Основной особенностью является ориентация оформления содержания
МД на два представления: электронное и печатное. Для всех объектов в модуле
данных имеются специфические настройки, определяющие вид того или иного объекта
при печати и на дисплее (рис. 4).

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

Простановка ссылок в редакторе не представляет никакой сложности. Поддерживаются
внутренние (перекрестные) ссылки на элементы текущего МД и внешние ссылки на
другие МД.

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

Интерактивные схемы с выносками позволяют оформлять различные чертежи и схемы.
Для этих объектов средствами TGBuilder можно организовывать интерактивные выноски.
Инструменты текстового редактора позволяют ссылаться из текста на конкретную
позицию в чертеже, схеме и т.п. Пользователь документации, изучая чертеж, может
получить информацию о том или ином элементе простым щелчком мыши на выноске.
Исходными объектами для организации подобных схем могут быть многочисленные
растровые форматы, а также чертежи в формате *.dxf, *.dwg (AutoDesk AutoCAD)
и *.wmf (Windows Metafile).

Внедрение интерактивных трехмерных объектов преследует аналогичные цели, что
и организация схем с выносками. Преимущество трехмерных моделей состоит в том,
что их можно импортировать непосредственно из CAD-систем. TGBuilder поддерживает
формат представления 3D-моделей IDASF, разработанный компанией Immersive Design.
Этот формат хранит каркасную модель изделия и позволяет не передавать параметры
модели (так как эти данные могут быть секретными), а также дает возможность
сократить объем файлов модели. Для перевода моделей в формат IDASF существуют
специальные программы-конверторы, которые распространяются либо как встроенные
средства CAD-систем либо как отдельные программные пакеты.

По встроенным схемам с выносками и по данным из 3D-моделей можно автоматически
получить спецификации с различными атрибутами и вставить их в содержание МД.

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

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

• список действий — текстовый список действий;
• иллюстрация;
• диалог «вопрос — ответ».

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

Формирование электронных каталогов

Как было сказано выше, электронный каталог по своей сути является таблицей и
предназначен для хранения различных перечней объектов. В зависимости от того,
какой тип перечней мы хотим хранить в таком представлении, меняется набор столбцов
этой таблицы. Например, для хранения каталога деталей и сборочных единиц в таблице
нужно предусмотреть следующие столбцы: «Наименование», «Обозначение», «Количество»,
«Масса», «Линейные размеры» и пр. Каждая деталь или сборочная единица в подобной
таблице будет представлена строкой (записью, позицией) с соответствующими значениями
в столбцах. Набор столбцов задается на стадии подготовки шаблона МД.

Наполнение электронных каталогов в системе TGBuilder может проводиться несколькими
способами. Первый (традиционный) — ручное заполнение всех столбцов для каждой
позиции каталога. В системе TGBuilder в столбцах электронного каталога могут
быть:

• строки;
• многострочный текст;
• списки значений и строк;
• ссылки на модули данных;
• ссылки на элементы 3D-моделей и схем с выносками;
• списки ссылок;
• файлы;
• цифровые изображения.

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

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

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

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

Сопровождение документации

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

• получение и учет пришедшего извещения об изменении (ИИ);
• анализ документации с целью выявления МД, подлежащих изменению;
• проведение соответствующих изменений;
• выгрузка обновлений ЭЭД на внешний носитель и передача изделия эксплуатанту.

Ведение электронного архива извещений

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

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

Проведение изменений в модулях данных

Если изменения по какому-либо извещению затрагивают содержание МД, это служит
причиной создания новой версии модуля данных. В поле «Причина выпуска новой
версии МД» указывается обозначение соответствующего ИИ и формализованная причина
изменений по ГОСТ.

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

Выгрузка обновлений

Система TGBuilder предоставляет возможность обновлений опубликованной документации.
Создание таких обновлений не очень отличается от процесса публикации исходной
документации. Как и при осуществлении публикации всей ЭЭД, в системе TGBuilder
указываются параметры статусных частей МД: дата выпуска, версия и т.д. Указанные
параметры влияют на состав набора МД, которые войдут в публикацию. Соответственно
можно сформировать такой набор, который составлен из версий МД, созданных в
определенный промежуток времени, например квартальных изменений.

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

«САПР и графика» 2’2003

Разработка эксплуатационной документации

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

Виды ЭД:

• руководство по эксплуатации (РЭ);
• инструкция по монтажу, пуску, регулированию и обкатке изделия (ИМ);
• формуляр (ФО);
• паспорт (ПС);
• этикетка (ЭТ);
• каталог деталей и сборочных единиц (КДС);
• нормы расхода запасных частей (НЗЧ);
• нормы расхода материалов (НМ);
• ведомость ЗИП (ЗИ);
• инструкции эксплуатационные специальные (ИС…);
• ведомость эксплуатационных документов (ВЭ).

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

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

Документы необходимые для разработки ЭД:
ТЗ, ТУ, Программы и методики испытаний, руководства, инструкции, паспорта на составные части продукции (в случае, если продукция специфицируемая) и т. п.

Качество ЭД в основном зависит от полноты и достаточности исходного материала.

Стадии разработки ЭД:

• анализ исходного материала;
• составление и согласование план-проспекта ЭД;
• разработка и оформление эксплуатационной документации в соответствии с требованиями ГОСТ Р 2.601, ГОСТ Р 2.610;
• экспертиза (нормоконтроль);
• корректировка проекта ЭД (при необходимости);
• сдача ЭД Заказчику.

Экспертиза эксплуатационной документации

Экспертиза ЭД проводится с целью решения основных задач:

• оценка качества ЭД (полнота изложенных сведений, достаточность и однозначность их восприятия);
• соответствие ЭД требованиям нормативной документации (ГОСТ 2.601, ГОСТ 2.610).

Электронный адрес для приема Ваших заявок info@tehdoc-razrabotka.ru

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

Второе название РЭ – инструкция по эксплуатации.

Цель разработки руководства

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

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

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

• Когда изготавливается новое изделие (для передачи заказчику);
• При сертификации продукции (передается в сертификационный центр);
• При импорте и таможенных досмотрах.

Требования к руководству по эксплуатации

Нормативно-технические акты, устанавливающие требования к РЭ:

• ГОСТ 2.601-2013 – описывает виды эксплуатационных документов, требования к ним и комплектность;
• ГОСТ 2.610-2006 – устанавливает правила составления различных эксплуатационных документов, в том числе РЭ.

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

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

ГОСТ на оформление РЭ

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

Стандартом 2.601-2013 разрешается составление руководства в электронной форме, что подразумевает возможность размещения и на сайте производителя. Дополнительно в отношении электронного РЭ будут действовать требования ГОСТ 2.051-2013, где отражена информация о правилах составления электронной конструкторской документации.

Руководство должно сопровождаться подробными техническими схемами. А из-за схожести инструкции по эксплуатации с паспортом на изделие, нормативами разрешается их объединение. В таком случае документ будет иметь название «Паспорт и руководство по эксплуатации».

Структура и содержание документа

Согласно ГОСТ 2.610-2006, устанавливающего требования к содержанию РЭ, оно должно состоять из введения и следующих разделов:

• 1 часть – описывает оборудование и его функции;
• 2 – содержит сведения об использовании по назначению;
• 3  – обозначает, как должно проводиться техническое обслуживание;
• 4 – отражает сведения о проведении текущего ремонта;
• 5 – оговаривает правила хранения;
• 6 – описывает информацию о правильной транспортировке;
• 7 – содержит данные об утилизации.

В этом же ГОСТе (номер 2.610-2006) можно увидеть примеры оформления титульного листа, образец внесения данных в разные части РЭ в табличной форме.

Как разработать документ?

Для разработки инструкции следует обращаться к специалистам.

Эксперты нашего центра помогут сориентироваться во всех требованиях стандартов. Мы оказываем услуги по разработке РЭ и правильно составим его в короткие сроки.   

Какие сведения потребуются?

Для разработки РЭ специалистам нужно будет предоставить ряд документов, таких как:

• Заявление;
• Описание продукции;
• Отсканированные копии учредительной документации;
• Реквизиты заявителя.

Для уточнения информации о составлении РЭ для вашей продукции обращайтесь к специалистам нашего центра удобным для вас способом. Мы оперативно ответим на все возникшие вопросы.

---

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

1. ЕСКД

В соответствии с ГОСТ 2.102-2003 (Единая система конструкторской документации (ЕСКД). Виды и комплектность конструкторских документов), эксплуатационная документация — это документы, предназначенные для использования при эксплуатации, обслуживании и ремонте изделия в процессе эксплуатации. Разрабатываются такие документы на этапе рабочего проектирования. Номенклатуру и обязательность разработки определяет ГОСТ 2.601-2013 (ЕСКД. Эксплуатационные документы). Правила выполнения определенных ЭД приведены в ГОСТ 2.610-2006 (ЕСКД. Правила выполнения эксплуатационных документов). Общие требования к оформлению документации — по ГОСТ 2.105-95 (ЕСКД. Общие требования к текстовым документам).

В ГОСТ 2.601 приведено определение эксплуатационного документа:

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

Где эксплуатация изделия – это стадия жизненного цикла изделия с момента принятия его потребителем от предприятия-изготовителя или ремонтного предприятия до отправки в ремонт или списания.

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

Виды, комплектность и выполнение (электронное или бумажное) ЭД устанавливает разработчик, опираясь на требования ТЗ и ЕСКД.

Ниже представлена таблица, где определены виды и номенклатура эксплуатационных документов в соответствии с ЕСКД.

Вид документа	Код вида доку-мента	Определение	Степень обязатель- ности разработки документа	Дополнительное указание
Руководство по эксплуатации	РЭ	Документ, содержащий сведения о конструкции, принципе действия, характеристиках (свойствах) изделия, его составных частях и указания, необходимые для правильной и безопасной эксплуатации изделия (использования по назначению, технического обслуживания, текущего ремонта, хранения и транспортирования) и оценок его технического состояния при определении необходимости отправки его в ремонт, а также сведения по утилизации изделия и его составных частей	о	–
Инструкция по монтажу, пуску, регулированию и обкатке изделия	ИМ	Документ, содержащий сведения, необходимые для монтажа, наладки, пуска, регулирования, обкатки и сдачи изделия и его составных частей в эксплуатацию на месте его применения	о	ИМ составляют на монтаж, пуск, регулирование и обкатку изделия на месте его применения и в случае, если эти требования нецелесообразно или невозможно изложить в РЭ
Формуляр	ФО	Документ, содержащий сведения, удостоверяющие гарантии изготовителя, значения основных параметров и характеристик (свойств) изделия, сведения, отражающие техническое состояние данного изделия, сведения о сертификации и утилизации изделия, а также сведения, которые вносят в период его эксплуатации (длительность и условия работы, техническое обслуживание, ремонт и другие данные)	+	Документ составляют на изделия, в период эксплуатации которых необходимо вносить сведения о значениях основных параметров и характеристиках (свойствах) изделия, отражающих техническое состояние данного изделия и/или данные о процессе эксплуатации (длительности и условиях работы, данные о проведении технического обслуживания, ремонта и другие данные)
Паспорт	ПС	Документ, содержащий сведения, удостоверяющие гарантии изготовителя, значения основных параметров и характеристик (свойств) изделия, а также сведения о сертификации и утилизации изделия	+	ПС составляют на изделия, для которых объем необходимых для эксплуатации данных и основных показателей незначителен и в период эксплуатации которого нет необходимости вносить сведения о значениях и/или подтверждении этих показателей
Этикетка	ЭТ	Документ, содержащий гарантии изготовителя, значения основных параметров и характеристик (свойств) изделия, сведения о сертификации изделия	+	ЭТ составляют на изделия, для которых данные, необходимые для эксплуатации, не превышают пяти-шести основных показателей, когда для подтверждения этих показателей нет необходимости составлять ФО (ПС) и технически их невозможно и/или нецелесообразно маркировать на изделии
Каталог изделий	КИ	Документ, содержащий перечень деталей, сборочных единиц и комплексов изделия с иллюстрациями и сведения об их количестве, расположении в изделии, взаимозаменяемости, конструктивных особенностях, материалах и др.	о	КИ составляют на изделия, для которых в течение времени эксплуатации предусмотрены неоднократный ремонт и замены составных частей
Нормы расхода запасных частей	НЗЧ	Документ, содержащий номенклатуру запасных частей изделия и их количество, расходуемое на нормируемое количество изделий за период их эксплуатации	о	Под НЗЧ на период эксплуатации одного изделия понимают среднее ожидаемое за этот период количество замен составных частей из-за отказов и выработки ресурсов
Нормы расхода материалов	НМ	Документ, содержащий номенклатуру материалов и их количество, расходуемое на нормированное количество изделий за период их эксплуатации	о	Под НМ на период эксплуатации понимают среднее ожидаемое за этот период количество расходуемых материалов
Ведомость комплекта запасных частей, инструмента и принадлежностей	ЗИ	Документ, содержащий номенклатуру, назначение, количество и места укладки запасных частей, инструментов, принадлежностей и материалов, расходуемых за срок службы изделия	о	ЗИ поставляют на изделия, с которыми совместно поставляют прилагаемые к ним комплекты ЗИП, а также наборы ЗИП, поставляемые отдельно от изделия, для эксплуатации которых предназначается ЗИП. Если количество наименований изделий и материалов незначительно, то ЗИ допускается не разрабатывать, а их номенклатуру перечислять в ФО или ПС
Учебно-технические плакаты	УП	Документы, содержащие сведения о конструкции изделия, принципах действия, приемах использования, техническом обслуживании, областях технических знаний с необходимыми иллюстрациями	о	УП выпускают по ГОСТ 2.605 (ЕСКД. Плакаты учебно-технические. Общие технические требования)
Инструкции эксплуатационные специальные	ИС	Документы, содержащие специальные требования, относящиеся к использованию по назначению, техническому обслуживанию, текущему ремонту, хранению, транспортированию и утилизации, оформленные в виде самостоятельных частей ЭД или в виде приложений к ним	о	Документы составляют на изделия, для которых в течение времени эксплуатации следует выполнять специальные требования, относящиеся к использованию по назначению, техническому обслуживанию, текущему ремонту, хранению, транспортированию и утилизации
Ведомость эксплуатационных документов	ВЭ	Документ, устанавливающий комплект эксплуатационных документов и места укладки документов, поставляемых с изделием и	+	ВЭ составляют на изделия, в комплект эксплуатационных документов которых входят два и более самостоятельных эксплуатационных документа
Условные обозначения: + – документ обязательный; о – необходимость разработки документа устанавливает разработчик (по согласованию с заказчиком). Примечание – В зависимости от назначения изделия, условий эксплуатации и объёма помещаемых сведений в обязательном порядке разрабатывают либо ФО, либо ПС, либо ЭТ, либо включают один из этих документов в объединённый ЭД.

В зависимости от особенностей изделия и объёма сведений о нём, допускается разделять документ на части или разрабатывать объединённый ЭД.

2. Автоматизированные системы

При разработке решений в области информационных технологий стандарты ЕСКД применяются к документации на технические средства. Документация на автоматизированные системы разрабатывается по  Комплексу стандартов на автоматизированные системы (КСАС, ГОСТ 34.*).

В соответствии с определением по ГОСТ 34.003-90 (Информационная технология. Комплекс стандартов на автоматизированные системы (КСАС). Автоматизированные системы. Термины и определения) эксплуатационная документация на автоматизированную систему (АС) – это часть рабочей документации на АС, предназначенная для использования при эксплуатации системы, определяющая правила действия персонала и пользователей системы при ее функционировании, проверке и обеспечении ее работоспособности. Перечень наименований разрабатываемых документов и их комплектность на систему и ее части должен быть определен в техническом задании на создание автоматизированной системы (подсистемы). Ниже приведена таблица, в которой приведены виды и номенклатура эксплуатационных документов в соответствии с             КСАС.

Вид документа	Код вида документа	Часть проекта	Дополнительные указания
Чертеж формы документа (видеокадра)	С9	ИО	В документе должно быть приведено изображение формы документа или видеокадра в соответствии с требованиями государственных стандартов унифицированной системы документации, Р 50-77 и необходимые пояснения. На стадии ТП допускается включать в документы Описание постановки задач (комплекса задач) Описание информационного обеспечения системы
Ведомость эксплуатационных документов	ЭД	ОР	Документ содержит перечень эксплуатационных документов согласно ГОСТ 34.201. Ведомость заполняют по разделам — частям проекта АС
Ведомость машинных носителей информации	ВМ	ИО	Ведомость машинных носителей информации содержит обозначения, наименования документов, выполненных на машинных носителях. Запись документов осуществляется в порядке возрастания присвоенных обозначений
Массив входных данных	В6	ИО	Документ содержит перечень входных данных с указанием их наименований, кодовых обозначений и значности реквизитов, а также наименований и кодовых обозначений документов или сообщений, содержащих эти данные
Каталог базы данных	В7	ИО	Каталог базы данных содержит перечень объектов предметной области АС, информация о которых включена в базу данных
Состав выходных данных (сообщений)	В8	ИО	Документ содержит перечень выходных данных с указанием их наименований, кодовых обозначений и значности реквизитов, а также наименований и кодовых обозначений документов или сообщений, содержащих эти данные
Методика (технология) автоматизированного проектирования	И1	ОО	Документ описывает выбранные математические методы, используемые при проектировании, указывают состав и назначение проектных процедур, порядок взаимодействия проектных процедур в процессе выполнения
Технологическая инструкция	И2	ОО	Документ «Технологическая инструкция» разрабатывают на операцию или комплекс операций технологического процесса обработки данных. В документе указывают наименование технологической операции (операций), на которую разработан документ, и приводят сведения о порядке и правилах выполнения операций (операции) технологического процесса обработки данных. В инструкции приводят перечень должностей персонала, на которые распространяется данная инструкция.  Номенклатуру технологических инструкций определяют, исходя из принятого процесса обработки данных. Структуру документа устанавливает разработчик в зависимости от содержания
Руководство пользователя	И3	ОО	Документ содержит полное описание системы, указания пользователю по подготовке к работе, освоению, эксплуатации системы,  действиях при возникновении проблем в работе системы.
Инструкция по формированию и ведению базы данных (набора данных)	И4	ИО	Документ описывает правила подготовки данных, порядок и средства заполнения, процедуры изменения, порядок и средства восстановления базы данных
Инструкция по эксплуатации КТС	ИЭ	ТО	Документ содержит указания о порядок работы, проверке правильности функционирования, меры безопасности, действиях в разных режимах при работе с комплексом технических средств системы
Описание технологического процесса обработки данных (включая телеобработку)	ПГ	ОО	Документ описывает технологический процесс сбора и обработки данных на периферийных устройствах при децентрализованной обработки данных и технологический процесс обработки данных на вычислительном центре
Общее описание системы	ПД	ОР	Документ содержит сведения о системе, ее архитектуре, принципах функционирования и необходимых ресурсах
Формуляр	ФО	ОР	Определения – по ГОСТ 2.601
Паспорт	ПС	ОР

Требования к содержанию документов приведены в РД 50-34.698-90 (Методические указания. Информационная технология. Комплекс стандартов и руководящих документов на автоматизированные системы. Автоматизированные системы требования к содержанию документов).

Содержание документов является общим для всех видов АС и, при необходимости, может дополняться разработчиком документов в зависимости от особенностей создаваемой АС. Допускается включать в документы дополнительные разделы и сведения, объединять и исключать разделы.

Общие требования к изложению текста документов – по ГОСТ 2.105-95 ЕСКД. Общие требования к текстовым документам.

3. ЕСПД

Сведения для обеспечения функционирования и эксплуатации программ (компонентов, комплексов) приводятся в эксплуатационной программной документации. Комплектность эксплуатационной документации на программные средства определяется по ГОСТ 19.101-77 (Единая система программной документации (ЕСПД). Виды программ и программных документов). Состав комплекта ЭД на программу зависит от её архитектуры, назначения и особенностей целевой аудитории. Необходимость составления того или иного документа определяется на этапе разработки и утверждения технического задания на программу. Ниже приведена таблица, в которой приведён перечень ЭД на программы.

Вид эксплуатационного документа	Код вида документа	Дополнительные указания
Ведомость эксплуатационных документов	20	В документе приводят перечень эксплуатационных документов на программу. Выполняется в соответствии с требованиями ГОСТ 19.507-79
Формуляр	30	В документе указывают основные характеристики программы, комплектность и общие сведения об эксплуатации программы.  Выполняется в соответствии с требованиями ГОСТ 19.501-78
Описание применения	31	В документе приводят сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств, входных и выходных данных. Выполняется в соответствии с требованиями ГОСТ 19.502-78
Руководство системного программиста	32	В документе приводят сведения для установки, проверки, обеспечения функционирования, интеграции в систему и настройки программы в определённых условиях применения ее, устранения аварийных ситуаций. Требования к содержанию и оформлению – по ГОСТ 19.503-79
Руководство программиста	33	В документе приводят сведения по эксплуатации (сопровождению) программы. Выполняется по ГОСТ 19.504-79
Руководство оператора	34	Документ содержит сведения о порядке действий оператора при использовании программы. Требования к содержанию и оформлению – по ГОСТ 19.505-79
Описание языка	35	Документ содержит описание синтаксиса и семантики языка, элементов и конструкций, встроенных функций. Выполняется по ГОСТ 19.506-79
Руководство по техническому обслуживанию	46	В документе приводят сведения для применения тестовых и диагностических программ при обслуживании технических средств.

Правила оформления программных документов для печатного способа выполнения установлены ГОСТ 19.106-78 (ЕСПД. Требования к программным документам, выполненным печатным способом).

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

Ниже приведена таблица, в которую включены стандарты  ИСО/МЭК, касающиеся процессов разработки программной и системной документации.

Обозначение	Наименование
ГОСТ Р ИСО/МЭК 12207-99	Информационная технология. Процессы жизненного цикла программных средств
ГОСТ Р ИСО/МЭК ТО 15271-2002	Информационная технология.Руководство по применению ГОСТ Р ИСО/МЭК 12207 Процессы жизненного цикла программных средств
ГОСТ Р ИСО/МЭК 9126-93	Информационная технология.Оценка программной продукции. Характеристики качества и руководство по их применению
ГОСТ Р ИСО/МЭК 15910-2002	Информационная технология.Процесс создания документации пользователя программного средства
ГОСТ Р ИСО/МЭК ТО 9294-93	Информационная технология.Руководство по управлению документированием программного обеспечения
ГОСТ Р ИСО/МЭК 15288-2005	Информационная технология.Системная инженерия.Процессы жизненного цикла систем
ISO/IEC 15289	Системная и программная инженерия.Содержание информационных продуктов (документации) процессов жизненного цикла систем и программных средств
ISO/IEC 26514	Системная и программная инженерия.Требования для проектировщиков и разработчиков документации пользователя
ISO/IEC 26513	Системная и программная инженерия.Требования по экспертизе и тестированию документации пользователя
ГОСТ Р 51904-2002	Программное обеспечение встроенных систем.Общие требования к разработке и документированию
ISO/IEC 18019:2004	Программная инженерия.Руководство по разработке и подготовке пользовательской документации на прикладные программные средства
ISO 6592:2000	Обработка информации.Руководство по документации для вычислительных систем
ГОСТ Р ИСО 9127-94	Системы обработки информации.Документация пользователя и информация на упаковке для потребительских программных пакетов.