Документирование

Документирование по ГОСТ Р 7.0.8-2013

Запись информации на носителе по установленным правилам [из п. 44 ГОСТ Р 7.0.8-2013]

Требования к содержанию и оформлению интерактивного электронного технического руководства [из подр. 5.3 ГОСТ Р 54088-2017]

Требования к содержанию и оформлению интерактивного электронного технического руководства [из подр. 5.3 ГОСТ Р 54088-2017]

Требования к содержанию ИЭТР устанавливаются в соответствии с ГОСТ 2.610 и нормативными документами, применяемыми для конкретных видов техники, в зависимости от вида(ов) ЭД (РД), выполняемого(ых) в форме ИЭТР [из п. 5.3.1 ГОСТ Р 54088-2017]

Реквизитная часть информационных объектов в ОБДЭ и в локальной БД ИЭТР - по ГОСТ 2.058 [из п. 5.3.2 ГОСТ Р 54088-2017]

Для идентификации информационных объектов в ОБДЭ и в локальных БД в составе ИЭТР используют коды (например, код МД, код СЧ по каталогу, логистический контрольный номер СЧ и т.д.) определенного синтаксиса и формата [из п. 5.3.3 ГОСТ Р 54088-2017]

Коды информационных объектов в ОБДЭ должны быть постоянными для всего ЖЦ изделия [из п. 5.3.4 ГОСТ Р 54088-2017]

ИЭТР представляют в одной из двух форм: странично-ориентированной и полностью интерактивной.

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

Во втором случае ИЭТР содержит локальную БД. ЭСО в составе ИЭТР обеспечивает полноценное интерактивное взаимодействие пользователя с указанной БД [из п. 5.3.5 ГОСТ Р 54088-2017]

Требования к функциональности интерактивного электронного технического руководства [из подр. 5.4 ГОСТ Р 54088-2017]

Требования к функциональности интерактивного электронного технического руководства [из подр. 5.4 ГОСТ Р 54088-2017]

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

  1. доступ;
  2. создание примечаний;
  3. поставка (распространение);
  4. контроль и прогнозирование;
  5. внешние процессы;
  6. использование графических объектов;
  7. создание ссылок;
  8. навигация и отслеживание;
  9. печать;
  10. использование специальных сведений;
  11. внесение изменений;
  12. выбор режима работы пользователя.

[из п. 5.4.1 ГОСТ Р 54088-2017]

В категории «доступ» задают требования в части разграничения доступа к данным между разными категориями пользователей [из п. 5.4.2 ГОСТ Р 54088-2017]

В категории «создание примечаний» задают требования в части возможностей пользователей добавлять метки и примечания к тексту и графике ИЭТР [из п. 5.4.3 ГОСТ Р 54088-2017]

В категории «поставка (распространение)» задают требования к способам передачи ИЭТР от поставщика к заказчику, а также способы доведения данных до конечных пользователей (эксплуатационного персонала заказчика). При установлении требований в этой категории учитывают располагаемые виды носителей информации и методы передачи данных, возможности существующей инфраструктуры и уровень подготовки пользователей к применению ИЭТР [из п. 5.4.4 ГОСТ Р 54088-2017]

В категории «контроль и прогнозирование» задают требования в части функциональных возможностей ИЭТР для его использования при выявлении отказов и повреждений изделия и (или) прогнозировании их появления путем контроля предотказных состояний СЧ изделия или изделия в целом [из п. 5.4.5 ГОСТ Р 54088-2017]

В категории «внешние процессы» задают требования в части функциональных возможностей ИЭТР, позволяющих пользователю интегрировать содержащиеся в ИЭТР данные в другие информационные системы (например, используемые для управления ТЭ). Такая совместная работа разных автоматизированных систем, как правило, повышает эффективность использования каждой из систем за счет обмена данными между ними [из п. 5.4.6 ГОСТ Р 54088-2017]

В категории «использование графических объектов» задают требования к способам взаимодействия с графической информацией, например:

При установлении требований в этой категории учитывают, что более сложные графические представления могут увеличить стоимость ИЭТР и повысить требования к программно-аппаратным средствам [из п. 5.4.7 ГОСТ Р 54088-2017]

В категории «создание ссылок» задают требования в части функциональных возможностей для организации переходов от одного элемента информации к другому (разные связи данных в составе ИЭТР), например переход по ссылке от содержания к указанному пользователем разделу или во внешние источники данных (например, для связи с БД материалов, оборудования и т.д.) [из п. 5.4.8 ГОСТ Р 54088-2017]

В категории «навигация и отслеживание» задают требования к применяемым методам навигации по содержанию ИЭТР, времени поиска нужных сведений, способам отслеживания истории работы с ИЭТР, установления закладок и т.п. При этом учитывают возможности использования как традиционных интерфейсов, так и голосовых команд, диалогового общения пользователя с ИЭТР, различных способов фильтрации, например фильтрации данных по наименованию типа, модели, идентификационному номеру (например, обозначению или заводскому номеру) изделия, номеру извещения об изменении (бюллетеня) или коду исполнителя работ и др. [из п. 5.4.9 ГОСТ Р 54088-2017]

В категории «печать» задают требования к организации с помощью ИЭТР печати ЭД (РД) в соответствии с требованиями к бумажной ЭД (РД) либо к печати отдельных элементов данных (таблиц, иллюстраций, снимков экрана и т.п.). Здесь же реализуют функции, обеспечивающие учет распечатанных на бумаге копий ЭД (РД) [из п. 5.4.10 ГОСТ Р 54088-2017]

В категории «использование специальных сведений» задают требования к воспроизведению с помощью программы просмотра дополнительных типов данных (например, аудио- и видеоданных или анимации). При установлении требований в этой категории учитывают, что включение возможности вывода более сложных мультимедийных данных может увеличить стоимость ИЭТР и повысить требования к программно-аппаратным средствам [из п. 5.4.11 ГОСТ Р 54088-2017]

В категории «внесение изменений» задают требования к способам внесения изменений в данные, содержащиеся в ИЭТР, и способам их отображения ЭСО. При просмотре изменения могут отмечаться специальными метками и иными признаками [из п. 5.4.12 ГОСТ Р 54088-2017]

В категории «выбор режима работы пользователя» задают требования к способам реализации в ИЭТР разных режимов работы пользователя, включая режимы доступа к внешним источникам данных. Как правило, функциональные возможности этой категории зависят от организации работ, производственного оснащения эксплуатанта изделия и возможностей программного обеспечения по взаимодействию с внешними источниками данных [из п. 5.4.13 ГОСТ Р 54088-2017]

Дополнительные элементы требований к функциональным характеристикам ИЭТР по указанным в 5.3.1 категориям приведены в приложении А [из п. 5.4.14 ГОСТ Р 54088-2017]

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

В заголовки столбцов таблицы (слева направо) помещают:

  • «Функциональные требования»;
  • «Форма ИЭТР»;
  • «Наименование».

В столбце «Функциональные требования» в качестве заголовка каждой из строк таблицы помещают категории функциональности (виды функциональных требований) согласно 5.3.1 и приложению А к настоящему стандарту.

В столбце «Форма ИЭТР» для каждого вида ИЭТР указывают его выполнение: странично-ориентированное или интерактивное.

В столбце «Наименование» для каждого вида ИЭТР указывают применимые функциональные требования. Для этого в ячейках матрицы, находящихся на пересечении столбца с наименованием вида ИЭТР и строки с наименованием (видом) функционального требования, проставляют символы (например, «X» или «+»), указывающие на необходимость данной функциональности для данного вида ИЭТР [из п. 5.4.15 ГОСТ Р 54088-2017]

Заполненная матрица функциональности содержит формализованные требования к функциональным характеристикам ИЭТР и может использоваться впоследствии при оценке соответствия ИЭТР заданным требованиям [из п. 5.4.16 ГОСТ Р 54088-2017]

Требования к электронной системе отображения [из подр. 5.5 ГОСТ Р 54088-2017]

Требования к электронной системе отображения [из подр. 5.5 ГОСТ Р 54088-2017]

На ЭСО, поставляемую в составе ИЭТР, разрабатывается комплекс программных документов в соответствии с ГОСТ 19.101. Виды программных документов устанавливаются разработчиком ИЭТР и согласуются с заказчиком [из п. 5.5.1 ГОСТ Р 54088-2017]

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

Задачи контроля качества документации [из подр. 4.2 ГОСТ Р 54087-2017]

Задачи контроля качества документации [из подр. 4.2 ГОСТ Р 54087-2017]

Для контроля качества ЭД и РД согласно 4.1.2, 4.1.3 выполняют проверки, содержание которых представлено в таблице 1.

Таблица 1 - Содержание контроля качества ЭД и РД

Наименование проверки

Содержание проверки (что проверяется)

Исполнители

1 Проверка выполнения требований к стилю изложения и оформлению

Соответствие обозначений документов и информационных объектов установленной системе обозначений.
Соответствие комплектности ЭД (РД) требованиям ГОСТ 2.601, ГОСТ 2.602 и ТЗ.
Соответствие реквизитных частей документов и информационных объектов требованиям ГОСТ 2.058 и других нормативных документов.
Проверка правильности применения сокращений и условных обозначений.
Проверка правильности ссылок на нормативные документы. Наличие установленных подписей.
Проверка правильности орфографии, синтаксиса, пунктуации, стиля изложения материала документации

Нормоконтролер, редактор

2 Проверка выполнения требований к содержанию

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

Рецензент, уполномоченный представитель заказчика

3 Проверка выполнения требований к функциональности ИЭТР

Проверка на соответствие требованиям ТЗ с использованием матрицы функциональности (матрица функциональности определена в ГОСТ Р 54088)

Рецензент, программист (оператор), уполномоченный представитель заказчика

4 Проверка выполнения требований к ЭСО и другим программно-техническим средствам

Проверка ка соответствие требованиям ТЗ и ГОСТ Р 54088. Проверка наличия и содержания программной документации требованиям ТЗ

Программист (оператор), рецензент

5 Проверка целостности данных

Проверка работоспособности внешних и внутренних ссылок. Проверка отсутствия ссылок на несуществующие (не применимые) информационные объекты и документы

Программист (оператор)

6 Проверка выполнения требований к модели данных

Проверка соответствия форматов, схем (моделей) данных требованиям применимых стандартов и ТЗ (например, проверка соответствия формата и схем МД требованиям [1])

Программист (оператор), уполномоченный представитель заказчика

7 Проверка других требований

Проверка других требований, установленных в ТЗ

[из п. 4.2.1 ГОСТ Р 54087-2017]

Все задачи контроля качества ЭД и РД выполняют итеративно, путем повторного выполнения проверок по мере готовности ЭД (РД), с участием в проверках разных специалистов как со стороны поставщика, так и со стороны заказчика (см. 4.3) [из п. 4.2.2 ГОСТ Р 54087-2017]

Испытания [из подр. 4.5 ГОСТ Р 54087-2017]

Испытания [из подр. 4.5 ГОСТ Р 54087-2017]

Решение о проведении испытаний для оценки качества электронной ЭД (РД) может быть принято как заказчиком, так и самим разработчиком изделия (комплекса). Как правило, объектом испытаний является комплект поставки электронной ЭД (РД) [из п. 4.5.1 ГОСТ Р 54087-2017]

Испытания проводит комиссия из представителей заинтересованных сторон, которая организует свою деятельность с учетом требований ГОСТ 16504:

[из п. 4.5.2 ГОСТ Р 54087-2017]

Для проведения испытаний разрабатывают программу и методики испытаний. Как правило, эти документы разрабатывает поставщик документации и согласует их с заказчиком (для изделий, разрабатываемых в интересах Министерства обороны РФ, с военным представительством или иным уполномоченным органом) [из п. 4.5.3 ГОСТ Р 54087-2017]

По завершении испытаний оформляют акт, подписываемый всеми членами комиссии. К акту прилагают протоколы и иные материалы, содержащие результаты конкретных видов испытаний, проведенных согласно 4.5.3 [из п. 4.5.4 ГОСТ Р 54087-2017]

Результаты испытаний учитывают при определении комплектности поставляемой заказчику документации (полный комплект для изделия, часть комплекта для отдельных СЧ либо отдельные документы или ИЭТР). Комплектность, сроки и условия поставки определяют в договоре.

Примечание - В договоре устанавливают требования к выполнению и условиям поставки ЭД (РД) также и для эксплуатируемых изделий, производство которых прекращено [из п. 4.5.5 ГОСТ Р 54087-2017]

Испытания [из подр. 4.5 ГОСТ Р 54087-2017]

Корректировка документации [из подр. 5.3 ГОСТ Р 54087-2017]

Корректировка документации [из подр. 5.3 ГОСТ Р 54087-2017]

Корректировку ЭД и РД в соответствии с представленными замечаниями выполняет группа технических писателей. Процесс корректировки начинается непосредственно после получения уведомления о ее необходимости (от редактора или рецензента) [из п. 5.3.1 ГОСТ Р 54087-2017]

Уведомление о необходимости корректировки содержит сведения о недостатках и рекомендации редактора (рецензента) по их устранению [из п. 5.3.2 ГОСТ Р 54087-2017]

При выполнении технической корректировки стиль изложения, язык и оформление ЭД и РД не проверяются и не изменяются [из п. 5.3.3 ГОСТ Р 54087-2017]

В случае, когда внесение исправлений влечет необходимость дополнения ЭД (РД) новыми МД, разделами и т. п., руководитель разработки должен дать разрешение на выполнение таких дополнений (изменение структуры и состава документации и т. п.) [из п. 5.3.4 ГОСТ Р 54087-2017]

По окончании корректировки доработанную ЭД (РД) повторно проверяют согласно 5.1 и 5.2 [из п. 5.3.5 ГОСТ Р 54087-2017]

Методы выполнения проверок документации [из подр. 4.4 ГОСТ Р 54087-2017]

Методы выполнения проверок документации [из подр. 4.4 ГОСТ Р 54087-2017]

Для проведения первой и второй проверок качества документации используют один из двух методов:

  1. проверка с использованием первичной конструкторской документации (чертежи, трехмерные модели, схемы изделия и его СЧ и т. д.);
  2. проверка с практической демонстрацией использования ЭД (РД).

Метод проверки выбирают в зависимости от степени готовности документации, вида технических данных в составе проверяемой документации, технических возможностей, располагаемого времени, безопасности, экономических и иных факторов [из п. 4.4.1 ГОСТ Р 54087-2017]

Проверка согласно 4.4.1 а) состоит в анализе первичной конструкторской документации компетентным экспертом (рецензентом) и сопоставлении результатов этого анализа с содержанием ЭД (РД), то есть информационного объекта ОБДЭ. Результатом проверки является документально зафиксированное заключение о степени соответствия ЭД (РД) установленным требованиям и о качестве выполнения документации (см. также раздел 5).

Примечание - В [1] такой метод проверки именуется «проверкой на столе» [из п. 4.4.2 ГОСТ Р 54087-2017]

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

Примечания

  1. В [1] такой метод проверки именуется «проверкой на объекте».
  2. При таком методе проверки решают задачи, предусмотренные пунктами 2, 3, 4, 6 таблицы 1.

[из п. 4.4.3 ГОСТ Р 54087-2017]

Программа обеспечения качества документации [из подр. 5.4 ГОСТ Р 54087-2017]

Программа обеспечения качества документации [из подр. 5.4 ГОСТ Р 54087-2017]

Для реализации приведенных в настоящем стандарте видов проверок и связанных с ними мероприятий согласно 5.1 и 5.2 разработчик ЭД (РД) должен подготовить, документально оформить, согласовать с заказчиком и утвердить программу обеспечения качества ЭД (РД). Для сохранения эффективности такая программа допжна систематически пересматриваться [из п. 5.4.1 ГОСТ Р 54087-2017]

В программе обеспечения качества отражают следующие темы:

[из п. 5.4.2 ГОСТ Р 54087-2017]

Стиль изложения, язык и оформление документации [из подр. 5.2 ГОСТ Р 54087-2017]

Стиль изложения, язык и оформление документации [из подр. 5.2 ГОСТ Р 54087-2017]

Проверку стиля изложения, языка и оформления ЭД и РД осуществляет редактор. Целью проверки является установление соответствия документации заданным требованиям и при необходимости выработка предложений по корректировке проверенных частей документации [из п. 5.2.1 ГОСТ Р 54087-2017]

Редактор проверяет предъявленную ему часть документации и представляет информацию о выявленных недостатках в группу технических писателей для корректировки ЭД (РД) [из п. 5.2.2 ГОСТ Р 54087-2017]

Процесс проверки начинается с получения редактором документации от группы технических писателей. При этом руководитель разработки документации должен обеспечить редактору возможность обратной связи с группой технических писателей для предоставления информации о промежуточных и окончательных результатах проверки. По окончании проверки редактор принимает решение о стилистической корректности и правильности оформления документации. В случае принятия положительного решения процесс заканчивается. В противном случае документацию вместе с подробным описанием недостатков и рекомендуемых методов их устранения отсылают на доработку группе технических писателей [из п. 5.2.3 ГОСТ Р 54087-2017]

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

[из п. 5.2.4 ГОСТ Р 54087-2017]

При необходимости процесс проверки стиля изложения, языка и оформления документации может повторяться по процедуре, устанавливаемой стандартом организации [из п. 5.2.5 ГОСТ Р 54087-2017]

По окончании проверки и устранения выявленных недостатков ЭД (РД) редактор принимает решение о надлежащем качестве стиля изложения, языка и оформления ЭД (РД) [из п. 5.2.6 ГОСТ Р 54087-2017]

Страницы

«Техническая документация»

Связь по эл. почте admin @ tdocs . su (без пробелов), тел. +7(967) 044-84-77 или в форме Контакты.

Copyright © «Техническая документация» 2008. Заимствуйте наши материалы с блеском! При воспроизведении материалов портала обязательна установка активной гиперссылки на источник — страницу с этой публикацией на tdocs.su.

Яндекс.Метрика