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

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

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

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

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

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

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

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

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

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

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

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

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

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

Контроль качества ЭД и РД выполняют на нескольких этапах разработки документации. Основными этапами контроля являются:

  1. входной контроль ЭД (РД), поступающей от смежников (партнеров);
  2. контроль качества информационных объектов ОБДЭ и ОБДЭ в целом в ходе их разработки;
  3. выходной контроль ИЭТР или комплекта электронных документов перед передачей заказчику.

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

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

Контроль качества информационных объектов ОБДЭ и ОБДЭ в целом в ходе разработки предполагает выполнение следующих видов проверок:

  • предварительная проверка;
  • проверка в процессе разработки:
  • первая проверка;
  • вторая проверка.

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

Предварительная проверка - процесс, при котором наиболее компетентные специалисты разработчика проверяют информационные объекты ОБДЭ по мере их готовности (в первую очередь, согласно пункту 2 таблицы 1) для того, чтобы на ранних этапах разработки устранить все недостатки. В рамках этих работ может также выполняться нормоконтроль (таблица 1, пункт 1) [из пп. 4.3.3.1 ГОСТ Р 54087-2017]

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

Первая проверка - окончательная проверка информационных объектов ОБДЭ ее разработчиком согласно пунктам 1, 2, 5, 6, 7 таблицы 1. После успешного прохождения проверки информационные объекты ОБДЭ получают официальный статус (например, «Утверждено»), подтверждающий их соответствие требованиям. Результаты первой проверки всей совокупности информационных объектов ОБДЭ (по конкретному изделию) фиксируются в акте (протоколе), утверждаемом уполномоченным руководителем разработчика ЭД (РД). В случае разработки ЭД (РД) в интересах Министерства обороны РФ акт (протокол) согласуют с уполномоченным представителем заказчика [из пп. 4.3.3.3 ГОСТ Р 54087-2017]

Вторая проверка - контроль заказчиком документации, сформированной из утвержденных объектов ОБДЭ в форме практической апробации с целью подтверждения ее достаточности для обеспечения эффективного и безопасного использования изделия и его СЧ и проверки соответствия требованиям в отношении функциональности и других требований ТЗ и нормативных документов. Выполняются проверки согласно пунктам 2, 3 и 7 таблицы 1.

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

Выходной контропь выполняет разработчик документации для проверки электронных документов и (или) ИЭТР, сформированных из ОБДЭ для передачи заказчику, на соответствие требованиям ТЗ. Выполняются проверки согласно пунктам 3, 4, 5, 6, 7 таблицы 1 [из п. 4.3.4 ГОСТ Р 54087-2017]

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

Общие сведения [из подр. 4.1 ГОСТ Р 54087-2017]

Общие сведения [из подр. 4.1 ГОСТ Р 54087-2017]

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

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

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

Объектами контроля являются:

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

Участниками контроля являются:

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

Общие требования к функциям автоматизированной системы управления данными об изделии [из разд. 5 ГОСТ Р 58675-2019]

Общие требования к функциям автоматизированной системы управления данными об изделии [из разд. 5 ГОСТ Р 58675-2019]

АС УДИ должна выполнять следующие основные функции:

[из подр. 5.1 ГОСТ Р 58675-2019]

АС УДИ должна хранить данные об изделии (в том числе его модификациях, вариантах, исполнениях и т. д.), необходимую нормативно-справочную информацию и служебные данные в объеме, необходимом для решения поставленных задач [из подр. 5.2 ГОСТ Р 58675-2019]

АС УДИ должна обеспечивать принцип однократного ввода данных и последующего их многократного использования на протяжении всего ЖЦ изделия [из подр. 5.3 ГОСТ Р 58675-2019]

АС УДИ должна обеспечивать уникальную идентификацию изделий, материалов, документов, процессов, организаций, элементов справочника и других сущностей, сведения о которых хранятся в АС УДИ [из подр. 5.4 ГОСТ Р 58675-2019]

АС УДИ должна поддерживать автоматический контроль полноты и целостности данных об изделии [из подр. 5.5 ГОСТ Р 58675-2019]

АС УДИ должна предоставлять средства для создания электронной структуры изделия (структур разного вида по ГОСТ 2.053). АС УДИ должна поддерживать возможность описания многовариантного изделия на базе единой (конфигурируемой) структуры.

Примечание - описание многовариантного изделия в одной структуре, как правило, реализуется путем накладывания ограничений на включение элементов в структуру изделия (применяемость, вариантные правила и др. механизмы в зависимости от особенностей конкретной АС УДИ). В качестве ограничения могут быть указаны варианты изделия, конкретные экземпляры изделия, диапазон дат и другие условия, при которых элемент разрешено использовать в структуре [из подр. 5.6 ГОСТ Р 58675-2019]

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

Примечание - автоматизация рабочих процессов, как правило, обеспечивается механизмами управления потоками работ (workflow), интегрированной в АС УДИ системой обмена сообщениями и другими механизмами. В качестве специализированных программных средств могут использоваться системы электронной подписи, шифрования и пр. [из подр. 5.7 ГОСТ Р 58675-2019]

АС УДИ должна поддерживать процессы управления конфигурацией и управления изменениями в объеме решаемых в организации задач. АС УДИ должна хранить сведения о выполненных изменениях (историю изменения) и необходимые сопроводительные данные, обосновывающие принятые решения. АС УДИ должна позволять по запросу получать данные, актуальные в определенные моменты времени [из подр. 5.8 ГОСТ Р 58675-2019]

АС УДИ должна поддерживать работу как в однопользовательском, так и в многопользовательском режимах. Для обеспечения распределенной работы с данными об изделии в многопользовательском режиме АС УДИ должна поддерживать механизмы обеспечения совместного изменения данных (например, блокировка на время изменения) [из подр. 5.9 ГОСТ Р 58675-2019]

АС УДИ должна поддерживать удостоверение выполненных пользователями действий над данными с использованием электронной подписи (требования к виду электронной подписи устанавливаются для конкретной АС УДИ в соответствии с Федеральным законом «Об электронной подписи» от 06.04.2011 № 63-ФЗ [из подр. 5.10 ГОСТ Р 58675-2019]

АС УДИ должна предоставлять возможности преобразования данных в соответствии с ГОСТ Р 58676 [из подр. 5.11 ГОСТ Р 58675-2019]

АС УДИ должна предоставлять возможности группирования данных об изделии по разным критериям (в том числе, например, формирование перечней разрешенных к применению изделий и/или материалов) [из подр. 5.12 ГОСТ Р 58675-2019]

АС УДИ должна предоставлять возможности поиска данных по разным критериям (и их сочетаниям), средства отображения результатов поиска, хранить истории запросов пользователя и выбранные запросы для их многократного выполнения [из подр. 5.13 ГОСТ Р 58675-2019]

АС УДИ должна предоставлять возможности сравнения данных об изделии(-ях) (например, сравнение актуальной на разные даты структуры изделия, сравнение вариантов изделия и т. п.) и средства отображения выявленных различий [из подр. 5.14 ГОСТ Р 58675-2019]

АС УДИ должна иметь встроенные средства для настройки и создания новых форм отчетов [из подр. 5.15 ГОСТ Р 58675-2019]

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

  • доступ на чтение;
  • доступ на изменение;
  • доступ на удаление;
  • доступ на изменение статуса данных (в том числе применяемости).

[из подр. 5.16 ГОСТ Р 58675-2019]

АС УДИ должна выполнять функции защиты информации, в том числе предотвращения утечки информации, защиты от несанкционированных и непреднамеренных воздействий на информацию, и защиту от других угроз в соответствии с ГОСТ Р 51275. АС УДИ должна соответствовать требованиям ГОСТ Р 50739 [из подр. 5.17 ГОСТ Р 58675-2019]

АС УДИ должна предоставлять средства для долговременного хранения данных об изделии, связанных с этими данными нормативно-справочной информации и служебных данных [из подр. 5.18 ГОСТ Р 58675-2019]

Основные положения [из разд. 4 ГОСТ Р 58675-2019]

Основные положения [из разд. 4 ГОСТ Р 58675-2019]

АС УДИ представляет собой вид АС, под управлением которой находятся (см. рисунок 1):

- Основные группы данных в АС УДИ

Рисунок 1 - Основные группы данных в АС УДИ

[из подр. 4.1 ГОСТ Р 58675-2019]

Пользователями АС УДИ с разными правами доступа к данным на разных стадиях ЖЦ могут быть: заказчик изделия (представитель заказчика), разработчик изделия, разработчики составных частей, изготовитель изделия, изготовители составных частей, эксплуатант изделия и другие участники ЖЦ изделия при необходимости [из подр. 4.2 ГОСТ Р 58675-2019]

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

Примечание - Наиболее часто необходимость обеспечения взаимодействия между несколькими АС УДИ возникает на этапе эксплуатации. Требования к передаче ЭДИ между организациями приведены в ГОСТ Р 54089 [из подр. 4.3 ГОСТ Р 58675-2019]

АС УДИ используется для решения задач на всех стадиях и этапах ЖЦ совместно с взаимосвязанными прикладными АС. Перечень таких АС в общем случае может включать (но не ограничен указанными ниже):

Данные об изделии, создаваемые в прикладной АС, размещаются и хранятся в АС УДИ, а также используются в качестве исходных данных для решения задач другими прикладными АС. Схема взаимодействия АС УДИ с прикладными АС приведена в приложении А [из подр. 4.4 ГОСТ Р 58675-2019]

Данные об изделии, хранящиеся в АС УДИ, являются источником для получения:

[из подр. 4.5 ГОСТ Р 58675-2019]

Данные об изделии в АС УДИ (см. рисунок 2) в общем случае могут включать (но не ограничены указанными ниже):

[из подр. 4.6 ГОСТ Р 58675-2019]

Нормативно-справочная информация в АС УДИ в общем случае может включать (но не ограничена перечисленными ниже):

- Данные об изделии в АС УДИ

Рисунок 2 - Данные об изделии в АС УДИ

  • данные о стандартных и унифицированных инструментах и технологической оснастке, применяемых организацией;
  • данные о стандартизованных процессах эксплуатации, применяемых организацией;
  • данные о стандартизованных и унифицированных средствах технического обслуживания, применяемых организацией;
  • данные о поставщиках, изготовителях, эксплуатантах и других организациях, участвующих в ЖЦ изделия;
  • справочники, применяемые в организации.

Содержание перечисленных данных может соответствовать 4.6 в необходимом объеме [из подр. 4.7 ГОСТ Р 58675-2019]

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

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

[из подр. 4.8 ГОСТ Р 58675-2019]

Схема взаимодействия автоматизированной системы управления данными об изделии с прикладными автоматизированными системами - Приложение А ГОСТ Р 58675-2019

Схема взаимодействия автоматизированной системы управления данными об изделии с прикладными автоматизированными системами - Приложение А ГОСТ Р 58675-2019

Данные об изделии, создаваемые в прикладной АС, размещаются и хранятся в АС УДИ, а также используются в качестве исходных данных для решения задач другими прикладными АС. В рамках интегрированной информационной среды обмен данными между прикладными АС в ходе ЖЦ изделия осуществляется посредством АС УДИ, обеспечивающей контроль целостности, непротиворечивости и полноты поступающих и передающихся данных. Условная схема взаимодействия АС УДИ с прикладными АС приведена на рисунке А.1.

- Схема взаимодействия АС УДИ с прикладными АС

Рисунок А.1 - Схема взаимодействия АС УДИ с прикладными АС

Схема взаимодействия автоматизированной системы управления данными об изделии с прикладными автоматизированными системами - Приложение А ГОСТ Р 58675-2019

Классификация тестовых программ [из разд. 4 ГОСТ Р 57700.18-2019]

Классификация тестовых программ [из разд. 4 ГОСТ Р 57700.18-2019]

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

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

Тестирование ВВС включает в себя следующие направления:

  • оценка эффективности применения ВВС в целом, а также оценка отдельных подсистем, компонент и параметров;
  • оценка производительности ВВС в целом, а также отдельных вычислительных устройств в различных режимах на актуальных для организации-пользователя задачах и алгоритмах;
  • оценка эффективности распараллеливания (возможности масштабирования) для задач различного класса с учетом особенностей алгоритмов распараллеливания;
  • оценка надежности ВВС в целом и ее отдельных компонент при проведении расчетов характерных задач в различных режимах;
  • оценка отдельных параметров коммуникационной подсистемы ВВС (максимальная и средняя скорость межпроцессорных обменов в зависимости от размера сообщения, бисекция и т. п.);
  • оценка производительности файловой подсистемы ВВС;
  • оценка работоспособности систем планирования заданий, мониторинга и диагностики.

[из подр. 4.3 ГОСТ Р 57700.18-2019]

Рассмотренный спектр направлений работ по тестированию ВВС определяет необходимость применения достаточно широкого набора тестов, начиная от системных до построенных на основе ПО КМ организации-пользователя.

По своему назначению и содержанию тесты разделяют на четыре группы:

  • специальные тесты для количественной оценки отдельных компонент и характеристик ВВС;
  • международные прикладные тесты для оценки производительности, эффективности распараллеливания, а также оценки отдельных параметров ВВС;
  • методические прикладные тесты для оценки правильности функционирования, эффективности распараллеливания и производительности ВВС. Могут создаваться организацией - пользователем ВВС либо сторонней организацией;
  • производственные тесты для оценки работоспособности и надежности ВВС на характерных для организации-пользователя задачах с использованием ПО КМ. Могут создаваться организацией - пользователем ВВС либо сторонней организацией.

[из подр. 4.4 ГОСТ Р 57700.18-2019]

Требования к тестовым программам [из разд. 5 ГОСТ Р 57700.18-2019]

Требования к тестовым программам [из разд. 5 ГОСТ Р 57700.18-2019]

Специальные ТП должны:

[из подр. 5.1 ГОСТ Р 57700.18-2019]

Международные прикладные ТП должны:

[из подр. 5.2 ГОСТ Р 57700.18-2019]

Методические прикладные ТП должны:

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

[из подр. 5.3 ГОСТ Р 57700.18-2019]

Производственные ТП должны:

  • являться образцами ПО КМ организации-пользователя ВВС (в том числе могут быть коммерческим ПО);
  • содержать описание функциональных возможностей и инструкцию по применению;
  • обеспечивать оценку правильности функционирования ВВС на задачах, характерных для организации-пользователя ВВС.

[из подр. 5.4 ГОСТ Р 57700.18-2019]

Общие требования к разработке КЛП [из разд. 4 ГОСТ 33353.3-2019]

Общие требования к разработке КЛП [из разд. 4 ГОСТ 33353.3-2019]

КЛП должен формироваться НЦК на основе информации о продукции, представленной предприятием-изготовителем для НК по правилам, установленным на национальном уровне [из подр. 4.1 ГОСТ 33353.3-2019]

КЛП должен иметь унифицированную форму и содержание реквизитов, обеспечивающих единую классификацию и идентификацию конкретной продукции и ее изготовителя [из подр. 4.2 ГОСТ 33353.3-2019]

КЛП должен содержать информацию о конкретной продукции или на группу однородной продукции, требования к которой установлены в одном нормативном или техническом документе [из подр. 4.3 ГОСТ 33353.3-2019]

Для систематизации продукции, представленной в КЛП, должен использоваться классификатор, гармонизированный с СКП-2 [из подр. 4.4 ГОСТ 33353.3-2019]

Не рекомендуется представлять для целей МК информацию:

  • печатной продукции (книги, брошюры, плакаты и т. п.);
  • единичной и уникальной продукции, изготовленной по заказу одного потребителя;
  • продукции, информация о которой имеет ограниченное распространение;
  • продукции, предназначенной для потребления внутри предприятия-изготовителя;
  • об опытной продукции и установочной серии продукции;
  • о продукции ремесленников и продукции народных промыслов.

[из подр. 4.5 ГОСТ 33353.3-2019]

Страницы

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

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

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

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