ГОСТ Р МЭК 62023-2016 Структурирование технической информации и документации

ГОСТ Р МЭК 62023-2016

НАЦИОНАЛЬНЫЙ СТАНДАРТ РОССИЙСКОЙ ФЕДЕРАЦИИ

СТРУКТУРИРОВАНИЕ ТЕХНИЧЕСКОЙ ИНФОРМАЦИИ И ДОКУМЕНТАЦИИ

Structuring of technical information and documentation

ОКС 29.020

Дата введения 2017-06-01

Предисловие

1 ПОДГОТОВЛЕН ООО "НИИ экономики связи и информатики "Интерэкомс" (ООО "НИИ "Интерэкомс") на основе собственного перевода на русский язык англоязычной версии стандарта, указанного в пункте 4

2 ВНЕСЕН Техническим комитетом по стандартизации ТК 100 "Стратегический и инновационный менеджмент"

3 УТВЕРЖДЕН И ВВЕДЕН В ДЕЙСТВИЕ Приказом Федерального агентства по техническому регулированию и метрологии от 10 октября 2016 г. N 1341-ст

4 Настоящий стандарт идентичен международному стандарту МЭК 62023:2011* "Структурирование технической информации и документации" (IEC 62023:2011 "Structuring of technical information and documentation", IDT).

________________

* Доступ к международным и зарубежным документам, упомянутым в тексте, можно получить, обратившись в Службу поддержки пользователей. - .

При применении настоящего стандарта рекомендуется использовать вместо ссылочных международных стандартов соответствующие им национальные стандарты Российской Федерации, сведения о которых приведены в дополнительном приложении ДА

5 ВВЕДЕН ВПЕРВЫЕ

Правила применения настоящего стандарта установлены в статье 26 Федерального закона от 29 июня 2015 г. N 162-ФЗ "О стандартизации в Российской Федерации". Информация об изменениях к настоящему стандарту публикуется в ежегодном (по состоянию на 1 января текущего года) информационном указателе "Национальные стандарты", а официальный текст изменений и поправок - в ежемесячном информационном указателе "Национальные стандарты". В случае пересмотра (замены) или отмены настоящего стандарта соответствующее уведомление будет опубликовано в ближайшем выпуске ежемесячного информационного указателя "Национальные стандарты". Соответствующая информация, уведомление и тексты размещаются также в информационной системе общего пользования - на официальном сайте Федерального агентства по техническому регулированию и метрологии в сети Интернет (www.gost.ru)

Введение

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

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

- дальнейшую детализацию и формализацию рекомендаций, уже изложенных в МЭК 61355-1:2008, путем утверждения концепции основного документа с прямыми ссылками на вспомогательные документы (в документе, утвержденном для данного технического объекта); и

- применение концепции объекта исходя из принципов структурирования документации (см. МЭК 81346-1). Это выходит за рамки существующих документов по той причине, что при этом показывается, как объекты с несколькими аспектами могут объединяться на систематической основе.

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

1 Область применения

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

2 Нормативные ссылки

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

_______________

* Таблицу соответствия национальных стандартов международным см. по ссылке. - .

IEC 61082-1:2014, Preparation of documents used in electrotechnology - Part 1: Rules (Подготовка документов, используемых при разработке электрофизических принципов в электротехнике. Часть 1. Правила)

IEC 61355-1:2008, Classification and designation of documents for plants, systems and equipment - Part 1: Rules and classification tables (Классификация и обозначение документов на промышленные установки, системы и оборудование. Часть 1. Правила и классификационные таблицы)

IEC 61360, Common Data Dictionary (CDD) (Словарь данных о компонентах) (см. http://std.iec.ch/iec61360)

IEC 62027:2011, Preparation of object lists, including parts lists (Составление перечней объектов, включая номенклатуры составных частей)

IEC/PAS 62569-1:2009, Generic specification of information on products - Part 1: Principles and methods (Групповые технические требования к информации о продукции. Часть 1. Принципы и методы)

IEC 81346-1:2009, Industrial systems, installations and equipment and industrial products - Structuring principles and reference designations - Part 1: Basic rules (Производственные системы, установки и оборудование и промышленная продукция. Принципы структурирования и условные обозначения. Часть 1. Основные правила)

IEC 82045-1:2001, Document management - Part 1. Principles and methods (Управление документооборотом. Часть 1. Принципы и методы)

IEC 82045-2:2004, Document management - Part 2: Metadata elements and information reference model (Управление документооборотом. Часть 2. Элементы метаданных и информационная эталонная модель)

ISO 7200:2004, Technical product documentation - Data fields in title blocks and document headers (Техническая документация на продукцию. Поля данных в блоках наименований и заголовках документа)

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

3 Термины и определения

В настоящем стандарте использованы следующие термины с соответствующими определениями.

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

3.1 Общие термины

3.1.1 объект (object): Сущность, рассматриваемая в процессе разработки, реализации, использования и утилизации.

Примечание 1 - Объект может являться физической или нефизической "вещью", т.е. ко всему тому что может существовать, существует или существовало ранее.

Примечание 2 - Объект обладает связанной с ним информацией.

[МЭК 81346-1:2009, определение 3.1]

3.1.2 система (system): Совокупность взаимосвязанных объектов, рассматриваемых в определенном контексте в целом и отделенных от окружающей (внешней) среды.

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

Примечание 2 - Систему, как правило, определяют для достижения поставленной цели.

Примечание 3 - Термин "система" должен быть точно определен, если из контекста не ясно, к чему он относится. Примеры системы: система привода, системы водоснабжения, стереосистема, компьютер.

Примечание 4 - Если система является частью другой системы, то ее можно считать объектом.

[МЭК 351-21-20, модифицированный]

3.1.3 установка; агрегат; оборудование (plant): Совокупность различных систем конкретного производственного объекта.

[МЭК 61355-1:2008, определение 3.10]

3.1.4 аспект (aspect): Определенный способ рассмотрения объекта.

[МЭК 81346-1:2009, определение 3.3]

3.1.5 структура (structure): Организация отношений между объектами системы, описывающей отношения объединений (состоит из/является частью).

[МЭК 81346-1:2009, определение 3.9]

3.1.6 экземпляр (объекта) [occurrence (of an object)]: Использование объектного типа в указанном контексте (другой объект или система) независимо от того, какой использован объектный индивид.

[МЭК 62507-1:2010, определение 3.15]

3.1.7 идентификатор (identifier): Атрибут, связанный с объектом и предназначенный для его однозначной идентификации в определенном домене.

Примечание - В системе идентификации может быть использовано несколько типов идентификаторов.

[МЭК 62507-1:2010, определение 3.8]

3.1.8 идентификационный номер (identification number; ID): Строка символов, характеризующих значение идентификатора.

Примечание 1 - На практике, хотя термин называется "идентификационный номер", строка также может содержать другие типы символов.

Примечание 2 - Термины "номер изделия", "номер элемента", "номер изделия по каталогу", "номер товара", "идентификационный номер продукции", "номер для отслеживания изделий" (для серии или партии) иногда используют как синонимы идентификационного номера.

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

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

Примечание 4 - Для продукции идентификационный номер, как правило, присваивается при проектировании объекта. Предполагается, что объекты с одним и тем же идентификационным номером имеют одинаковые "форму, размеры и функции" и поэтому должны быть взаимозаменяемыми.

[МЭК 62507-1:2010, определение 3.5]

3.1.9 идентификация (деятельность) [identification (activity)]: Действие, предназначенное для связывания идентификационных номеров с объектом.

[МЭК 62507-1:2010, определение 3.4]

3.1.10 номер продукта, код товара, номер составной части/изделия, идентификационный номер составной части (product number, product ID, part number, part ID): Идентификационный номер продукции, основанный на системе идентификации, которая используется в конкретной организации.

Примечание - Термин "составная часть/изделие" часто является синонимом термина "продукт", который может использоваться в качестве компонента в одном или нескольких собранных продуктах (состоящих из компонентов). По этой причине термин "номер составной части" часто является синонимом термина "номер продукта".

3.1.11 условное обозначение (reference designation): Идентификатор конкретного объекта, сформированного в соответствии с требованиями к системе, в которой объект является составным с точки зрения одного или нескольких аспектов этой системы.

[МЭК 81346-1:2009, определение 3.11]

3.1.12 система условных обозначений (reference designation set): Набор из двух и более условных обозначений, присвоенных объекту, по меньшей мере одно из которых будет однозначно идентифицировать данный объект.

[МЭК 81346-1:2009, определение 3.14]

3.1.13 тип (объекта) [type (of object)]: Класс объектов, имеющих один и тот же набор характерных свойств.

[МЭК 62507-1:2010, определение 3.16]

3.2 Термины, относящиеся к структуре документации

3.2.1 документ (document): Фиксированный и структурированный объем информации, которым можно управлять и осуществлять взаимообмен между пользователями и системами в качестве отдельной единицы информации.

Примечание 1 - Единица информации не обязательно может восприниматься пользователем, она обычно хранится на носителях данных.

Примечание 2 - Термин "документ" не ограничен его значением в юридическом смысле.

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

[МЭК 61082-1:2014, определение 3.1.2 и МЭК 82045-1:2001, определение 3.2.3]

3.2.2 номер документа, идентификационный номер документа (document number, document ID): Идентификационный номер, присваиваемый данному документу.

[МЭК 82045-2: 2004, раздел 8]

3.2.3 документация (documentation): Совокупность документов, относящихся к конкретной тематике.

Примечание 1 - Может включать в себя техническую, коммерческую и/или иную документацию.

Примечание 2 - Термин "тематика" может относиться к объектам, рассматриваемым в соответствии с МЭК 81346 или другими принятыми соображениями.

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

Примечание 4 - Число и вид документов в документации могут зависеть от ее назначения.

[МЭК 61355-1:2008, определение 3.5]

3.2.4 комплект документов (document set): Совокупность различных документов, рассматриваемая в качестве единого целого.

Примечание - Совокупность может состоять из документов и составных документов.

[МЭК 61355-1:2008, определение 3.4]

3.2.5 основной документ, руководящий документ (main document, leading document): Документ, характеризующий объект и содержащий полную информацию о нем (или же ссылающийся на эту информацию).

3.2.6 одноуровневый основной документ (single-level main document): Основной документ, определяющий только один уровень совокупности субобъектов.

3.2.7 многоуровневый основной документ (multi-level main document): Основной документ, определяющий несколько уровней совокупности субобъектов.

3.2.8 дополнительный документ, вспомогательный документ (complementary document, supplementary document): Ссылочный документ, содержащий лишь часть информации об объекте.

Примечание - Вспомогательные документы могут содержать подробную информацию, тогда как основной документ может содержать информацию только о структуре вспомогательных документов.

Пример - Чертежи могут быть вспомогательными документами к перечням объектов.

3.2.9 вид документа (document kind): Тип документа, определяемый в соответствии с содержащейся в нем информацией и формой ее представления.

Примечание - Иногда термин "вид документа" (document type) используют в том же значении.

[МЭК 61355-1:2008, определение 3.6]

3.2.10 вид (тип) класса документа (document kind class): Группа видов документов, обладающих сходными характеристиками (с точки зрения содержания информации, независимо от формы ее представления).

[МЭК 61355-1:2008, определение 3.7].

3.3 Термины, относящиеся к структуре документов

3.3.1 часть документа (document part): Идентифицируемая часть документа, имеющая определенное назначение в самом документе.

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

3.3.2 составной документ (composite document): Документ, содержащий различные фрагменты информации, каждый из которых связан с различными видами классов документов.

[МЭК 61355-1:2008, определение 3.3]

3.3.3 элемент списка (list item): Представление в виде части таблицы или списка упорядоченного множества значений характеристического свойства, относящегося к одному конкретному объекту.

[МЭК 62027:2011, определение 3.3.1]

3.3.4 содержимое списка документов (document list body): Таблица, содержащая элементы списка, в котором указаны документы.

3.3.5 содержимое списка объектов (object list body): Таблица, содержащая элементы списка, в котором указаны объекты, составляющие их совокупность (или часть совокупности) или систему (и при необходимости ссылочные документы).

[МЭК 62027:2011, определение 3.3.2]

4 Общие положения

4.1 Основные принципы структурирования систем, установок и продукции

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

В соответствии с МЭК 81346-1 структуры можно рассматривать (в зависимости от конкретного аспекта), например, как:

- функционально-ориентированную структуру;

- структуру, ориентированную на продукцию;

- структуру, ориентированную на местоположение.

Для определенных целей могут подходить и другие виды структур.

Каждая структура формируется в виде иерархического древа (см. рисунок 1), узлами которого являются объекты, представляющие интерес с точки зрения выбранного аспекта. Древо разделено на составляющие (компоненты) - объекты нижнего уровня, показанные на ветвях древа, которые, в свою очередь, могут также делиться на ветви со своими компонентами и т.д.

Product aspect (-) - аспект продукта (-); Object <top node> - объект (верхний узел); Location aspect (+) - аспект (место)положения (+); Sub-objects in location aspect - субобъекты в аспекте положения; Location-oriented structure - структура, ориентированная на местоположение; Function-oriented structure - функционально-ориентированная структура; Sub-objects in function aspect - субобъекты в аспекте функции; Node - узел; Branch - ветвь; Function aspect - аспект функции; функциональный аспект (=); Sub-objects in product aspect - субобъекты в аспекте продукции; Product-oriented structure - структура, ориентированная на продукцию

Рисунок 1 - Представление объекта с точки зрения трех аспектов, каждый из которых использован для субструктурирования

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

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

Примечание 1 - В документах, в которых информацию представляют в соответствии с функционально-ориентированной структурой, на первый план выдвигаются функциональные взаимосвязи между компонентами этой системы;

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

Примечание 2 - В документах, в которых информацию представляют в соответствии со структурой, ориентированной на продукцию, на первый план выдвигаются "физические" механизмы взаимодействия различных компонентов системы;

- структура, ориентированная на местоположение, основана на топографическом или пространственном расположении компонентов объекта. Эта структура показывает подразделение системы на компоненты объектов, принимая во внимание аспект положения, но без учета возможных аспектов продукции/функции этих объектов.

Примечание 3 - В документах, в которых информацию представляют в соответствии со структурой, ориентированной на местоположение, на первый план выдвигаются "топографические" взаимоотношения между различными компонентами в этой системе.

Для получения дополнительной информации о структурировании объектов см. МЭК 81346-1.

4.2 Объекты и описывающие их документы

Существует ряд различных способов получения, представления, хранения и распространения информации об объектах.

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

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

4.3 Структура системы документации и структура документа

4.3.1 Структура системы документации

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

Указанная структура, использующая преимущества объектно-ориентированной концепции, достаточно точно отражает структуру реальной установки, системы, оборудования или продукта. Определенные документы должны быть связаны исключительно с объектом в целом или с теми или иными субобъектами и ни с чем другим.

Примечание - Тем не менее последнее не запрещает использование любого документа из комплекта документации (в виде ссылки) также с целью предоставления информации о другом объекте, но при условии, что она в целом в данном контексте имеет отношение к данному вопросу.

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

4.3.2 Структура документа

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

Часть документа представляет собой информационный субобъект, который существует как таковой и характеризуется тем, что:

- имеет логически обоснованную форму представления (например, в виде текста, чертежа и т.п., с которым можно манипулировать с помощью конкретного средства); или

- связан с конкретным разделом (например, с главой и разделом в тексте, см. также рисунок 2); или

- представляет собой определенный субобъект (например, экземпляр класса на круговой диаграмме); или

- формирует "физический" (компоновочный) блок (например, страницу или иллюстрацию, которые должны быть расположены на одной странице) и т.д.

Часть документа является идентифицируемой, и ею можно управлять, как и всем документом в целом.

Часть документа может состоять из других частей, и поэтому ее можно организовать в виде структуры документа типа "состоит из/является частью", которая всегда присуща составным документам.

What is it? - что это?; Prepared by whom, when and where? - кем, когда и где подготовлено?; What happened, when and why? - что произошло, когда и почему?; Consists of what and how? - что включает в себя и как?

Рисунок 2 - Информационное содержание документа, включающего описание объекта

4.3.3 Грань между структурой документации и структурой документа

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

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

В качестве примера одного из вариантов документирования объект можно реализовывать либо в виде комплекта документов (каждый из которых должен иметь логически обоснованную форму представления), либо в виде составного документа (в котором каждая из его частей может иметь собственную форму представления) (см. рисунок 4).

5 Основные и вспомогательные документы

5.1 Общие положения

Необходимо, чтобы информация, которая должна быть предоставлена в отношении объекта, была четко связана с самим объектом.

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

Main document - основной документ; Complementary documents - вспомогательные документы; Object list - список объектов

Рисунок 3 - Структура документации для одиночного объекта

Основной документ должен полностью характеризовать технический объект и обладать следующими особенностями:

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

- он должен быть прямо или косвенно связан со всеми вспомогательными документами с помощью отдельного списка документов.

Вспомогательные документы не должны ссылаться обратно на основной документ.

Примечание 1 - Если вспомогательные документы используют вместе с несколькими основными документами, то этот возврат может создавать потребности в обновлении взаимосвязанных документов.

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

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

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

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

5.2.1 Части документа

Основной документ должен содержать административную часть и часть со списком вспомогательных документов ("списком содержимого документов") или ссылку на подобный список. Кроме того, он может содержать:

- часть, содержащую характеристические свойства объекта ("список содержимого свойств");

- часть, содержащую список компонентов (составляющих) объекта ("список содержимого объектов").

В приложении А приведен пример основного документа, содержащего указанные части.

Для ознакомления с административной частью основного документа см. МЭК 82045-1 и МЭК 82045-2, устанавливающие требования к управлению документооборотом.

5.2.2 Часть основного документа, содержащая сведения о вспомогательных документах

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

К обязательным метаданным относится:

- идентификационный номер документа - <Documentld>.

К необязательным метаданным относятся:

- код языка - <LanguageCode>;

- номер редакции - <DocumentRevisionld>;

- код вида документа - <DocumentClassldlEC61355>;

- вид документа - <DocumentClassName>;

- наименование - <Title>.

Все приведенные метаданные более подробно описаны в МЭК 82045-2 и указаны в угловых скобках (< >).

5.2.3 Часть основного документа, содержащая характеристические свойства объекта

Данная часть документа должна содержать спецификацию или описание объекта с учетом его характеристических свойств и должна быть подготовлена в форме "списка содержимого свойств", в котором элементы списка свойств должны определяться с помощью наиболее важных для документов метаданных с целью их однозначной идентификации и отслеживаемости (подконтрольности). Существующие метаданные необходимо использовать с учетом соответствующих определений типов элементов данных, приведенных в МЭК 61360 и ИСО 13584.

Значения свойств, как правило, связаны с конкретной стадией жизненного цикла объекта, например "в состоянии поставки" (as supplied), т.е. значения свойств "по факту изготовления" или "в соответствии с требованиями" заказчика.

При предоставлении значений свойств, связанных с несколькими фазами жизненного цикла объекта, указанные свойства необходимо квалифицировать по отдельности. Для получения дополнительной информации см. МЭК/ПАС 62569-1, а также пример в приложении А.

5.2.4 Часть основного документа, содержащая сведения о компонентах объекта

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

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

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

5.3 Взаимосвязь между основным документом и вспомогательными документами

5.3.1 Основной документ

Согласно 5.2 основные документы обычно строятся на следующих видах документов:

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

- списке объектов (см. рисунок 4b); в этом случае список содержимого объекта является доминирующим. Для получения более подробной информации о списке объектов, в том числе о спецификациях, см. МЭК 62027;

- списке документов (см. рисунок 4с); в этом случае список содержимого документов является доминирующим. Область применения этого списка ограничивается реальным объектом.

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

Основной документ также может принимать форму одиночного составного документа, содержащего весь набор информации о рассматриваемом техническом объекте (см. рисунок 4а).

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

5.3.2 Вспомогательные документы

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

Main document - основной документ; Component drawing - чертеж компонента; One single (composite) document - одиночный составной документ; Complementary documents - вспомогательные документы; Object list - список объектов; Object list, containing a document list body and an object list body - список объектов со списками содержания документа и объектов; List of documents - список документов; Figure - рисунок

Рисунок 4а) - полная информация содержится в одном (составном) документе, который становится основным документом. Рисунок 4b) - полная информация содержится в наборе документов. При этом основным документом является список объектов/составных частей, в котором перечислены все компоненты и все вспомогательные документы. Рисунок 4с) - полная информация содержится в комплекте документов. При этом основным документом является список документов, в котором перечислены все дополнительные документы, включая список объектов/составных частей.

Рисунок 4 - Основной документ и вспомогательные документы; иллюстрация различной степени разнесения информации по различным документам

5.4 Одно- и многоуровневые основные документы

В процессе проектирования и инженерно-технической разработки определенные структуры обычно содержат объекты, содержащие различные структурные уровни.

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

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

5.5 Классификация основных документов

Если применена система классификации типов документов, соответствующая используемой в МЭК 61355-1, то основные документы должны быть отнесены к классу АВ [т.е. к спискам (относящимся к документам) в соответствии с таблицей А.2 - DCC и описанием классов типов документа], независимо от того, на каком виде документа основана система, поскольку его роль быть основным документом является доминирующей по отношению к административной части документа.

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

6 Формы представления объекта

6.1 Общие положения

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

- систематическое структурирование в соответствии с МЭК 81346-1, проводимое с целью определения и идентификации объектов;

- кластеризация (группировка) информации для каждого такого объекта с помощью основного документа согласно разделу 5.

Задокументированный тип объекта может определяться с помощью ссылки на основной документ.

Рисунок 5 иллюстрирует принцип образующейся системы документации с объектами, расположенными в виде древовидной структуры, и документами, относящимися к каждому объекту. Каждый из объектов состоит из компонентов, показанных на рисунке 3. Стрелки, указывающие на "общий ресурс документа" слева, иллюстрируют возможность многократного использования вспомогательных документов.

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

- представление типа объекта с помощью его экземпляров (см. 6.2);

- привязку экземпляров объекта к документации, связанной с данным типом объекта (см. 6.3);

- представление метаданных в идентификационной области документов (см. 6.4).

6.2 Представление типа объекта с помощью его экземпляров

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

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

Следующие примеры иллюстрируют изложенный выше принцип:

- в списках объектов - элемент списка должен содержать:

- экземпляр класса (условное обозначение),

- тип (обозначение типа или номер составной части) и, при необходимости,

- свойства (наиболее значимые свойства в реальном контексте);

- в диаграммах - представление объекта с помощью диаграммы экземпляров или символа, содержащего:

- экземпляр (условное обозначение),

- обозначение типа или основной документ на объект,

- его условное обозначение,

- контакты и электрические или иные соединения с ними;

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

- экземпляр (условное обозначение),

- обозначение типа или основной документ на объект,

- условное обозначение,

- фактические размеры и фактические соединения с другими частями.

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

Для получения дополнительной информации об использовании диаграмм экземпляров и символов на диаграммах см. МЭК 61082-1, раздел 11.

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

6.3 Сопоставление объектов

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

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

6.4 Метаданные документов

Документы должны быть связаны с метаданными в соответствии с МЭК 82045-1 и МЭК 82045-2. Некоторые из этих данных представлены в области идентификации документа [т.е. в штампе чертежа (основной надписи), см. ИСО 7200].

Метаданные документов, связанные с типом объекта, должны быть связаны только с данным типом объекта. Другие ссылки не следует указывать на объекты, не связанные с данным типом, или на экземпляры данного типа объекта.

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

Main document - основной документ; Complementary documents - вспомогательные документы; Common document resource - общий источник документов; Documents for multiple use - документы многократного использования

Рисунок 5 - Взаимосвязи между объектами и документами

Приложение А
(справочное)

Пример составного основного документа, основанного на списке составных частей

Данный пример иллюстрирует возможный способ подготовки основного документа на основе документа со списком составных частей, который был дополнен частями с характеристическими данными (см. А.1) и вспомогательными документами (см. А.2), помимо существующей части документа для составных объектов (см. А.3). В данном примере предполагается, что объект внутри себя содержит лишь один аспект продукта. При наличии нескольких аспектов (как в А.3) их следует добавлять в каждую часть. Рассматриваемый основной документ упомянут в приложении В, раздел В.4.

А.1 Характеристические свойства

Примечание - Используется для представления списков объектов более высокого уровня (см. МЭК 62027, приложение А).

А.2 Дополнительные документы

А.3 Составные объекты (в соответствии с аспектом продукции и МЭК 62027, Класс В)

Приложение В
(справочное)

Пример составного основного документа, основанного на списке документов, ссылок на технические характеристики, списках объектов и др.

Данный пример иллюстрирует возможный способ подготовки основного документа на основе списка документов (см. В1), ссылок на отдельные документы с характеристическими свойствами (см. В.2) и списка составных объектов (см. В.3, В.4 и В.5). Объект является "верхним узлом", идентифицируемым по номеру документа (<7АВС12345>, МЭК 81346-1). Все условные обозначения, используемые в данном примере, относятся к рассматриваемому верхнему узлу. В данном примере предполагается, что объект внутри содержит три аспекта - аспект функции (PF), аспект продукции (РВ) и аспект положения (PL). При использовании только одного-двух аспектов списки объектов для оставшегося аспекта следует просто исключить.

В.1 Список документов

В.2 Технический паспорт

В.3 Список функций

Примечание - В данном примере нет основных документов, разделенных на структурные уровни. См. 5.4.

В.4 Перечень составных частей

Примечание 1 - Только узлы, представленные в этом примере, например списки.

Примечание 2 - В основных документах для этих компонентов также указываются узлы.

В.5 Список мест размещения устройств

Примечание - Области, представленные в данном примере, - только списки.

Приложение ДА
(справочное)

Сведения о соответствии ссылочных международных стандартов межгосударственным стандартам

Таблица ДА.1

Библиография

Электронный текст документа

и сверен по:

, 2016