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

4.3.1 Структура системы документации ГОСТ Р МЭК 62023-2016

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

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

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

Определенные таким образом комплекты документов могут затем как единое целое подвергаться обработке для встраивания в различные контексты, что является необходимым условием для эффективного многократного использования информации [из 4.3.1 Структура системы документации ГОСТ Р МЭК 62023—2016]

    4.3.2 Структура документа ГОСТ Р МЭК 62023-2016

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

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

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

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

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

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

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

    [из 4.3.2 Структура документа ГОСТ Р МЭК 62023—2016]

      4.3.3 Грань между структурой документации и структурой документа ГОСТ Р МЭК 62023-2016

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

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

      В качестве примера одного из вариантов документирования объект можно реализовывать либо в виде комплекта документов (каждый из которых должен иметь логически обоснованную форму представления), либо в виде составного документа (в котором каждая из его частей может иметь собственную форму представления) (см. рисунок 4) [из 4.3.3 Грань между структурой документации и структурой документа ГОСТ Р МЭК 62023—2016]

        5.1 Общие положения ГОСТ Р МЭК 62023-2016

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

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

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

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

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

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

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

        Примечания

        1. Если вспомогательные документы используют вместе с несколькими основными документами, то этот возврат может создавать потребности в обновлении взаимосвязанных документов. Подобным образом всегда можно обращаться к основному массиву информации либо по номеру составной части (увязывая его с оформлявшей составную часть организацией), либо по идентификатору верхнего узла, либо по условному обозначению, идентифицирующему данный объект (увязывая его с системой, продуктом и т. п.). Кроме того, можно обращаться к тем же вспомогательным документам (и использовать их) для ряда аналогичных объектов.
        2. Поскольку ссылки на дополнительные документы делаются однозначно, отсутствует необходимость в систематической нумерации документов.
        3. В системах управления данными о продуктах (PDM–системах) «объекты» (в структуре, ориентированной на продукцию), являющиеся информационными объектами с контролируемой конфигурацией, логически соответствуют основным документам, однако, хотя они и отвечают всем необходимым требованиям, предъявляемым к документам, они могут таковыми не считаться.

        [из 5.1 Общие положения ГОСТ Р МЭК 62023—2016]

          5.2.1 Части документа ГОСТ Р МЭК 62023-2016

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

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

          Для ознакомления с административной частью основного документа см. МЭК 82045—1 и МЭК 82045—2, устанавливающие требования к управлению документооборотом [из 5.2.1 Части документа ГОСТ Р МЭК 62023—2016]

            5.2.2 Часть основного документа, содержащая сведения о вспомогательных документах ГОСТ Р МЭК 62023-2016

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

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

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

            • код языка — <LanguageCode>;
            • номер редакции — <DocumentRevisionld>;
            • код вида документа — <DocumentCiassldlEC61355>;
            • вид документа — <DocumentClassName>;
            • наименование — .

            Все приведенные метаданные более подробно описаны в МЭК 82045—2 и указаны в угловых скобках (< >) [из 5.2.2 Часть основного документа, содержащая сведения о вспомогательных документах ГОСТ Р МЭК 62023—2016]

              5.2.3 Часть основного документа, содержащая характеристические свойства объекта ГОСТ Р МЭК 62023-2016

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

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

              При предоставлении значений свойств, связанных с несколькими фазами жизненного цикла объекта, указанные свойства необходимо квалифицировать по отдельности. Для получения дополнительной информации см. МЭК/ПАС 62569—1, а также пример в приложении А [из 5.2.3 Часть основного документа, содержащая характеристические свойства объекта ГОСТ Р МЭК 62023—2016]

                5.2.4 Часть основного документа, содержащая сведения о компонентах объекта ГОСТ Р МЭК 62023-2016

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

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

                Основной документ можно использовать для определения объекта в части многих аспектов путем присоединения списка содержимого объекта к каждому соответствующему аспекту (см. приложение А) [из 5.2.4 Часть основного документа, содержащая сведения о компонентах объекта ГОСТ Р МЭК 62023—2016]

                  Страницы

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