Версионность изделий и конструкторских документов

Версионность изделий и конструкторских документов
Теги: GIT, ГОСТ, ЕСКД, ЕСПД, КСАС

Содежание

{literal}

Жизненный цикл любого успешного проекта, продукта, изделия или компьютерной программы может быть очень долгим; изменения в бывают разными — от исправления ошибок до полного переписывания и переделывания. В большинстве случаев название остаётся тем же, изменяется подназвание — так называемая версия.

Версия может быть целым числом (IPhone 11), последовательностью чисел (JDK 1.0.3), годом (Windows 2000) или текстом (IPhone X). В любом случае, система версионирования выбирается по нескольким критериям:

  • Поддержка той или иной системы со стороны ПО для разработки (компилятора, системы контроля версий и т. д.).
  • Частота выхода новых версий и их «сырость». Сложный продукт, выпускаемый раз в несколько лет и перед выпуском проходящая всеобъемлющее тестирование и испытания, может именоваться как «Microsoft Word 97 SP2», в то время как в продукте с частыми малостабильными выпусками приходится вводить более сложную нумерацию.
  • Степень совместимости сетевых протоколов, документов или надстроек сторонних разработчиков.
  • Маркетинговые соображения.

Иногда присутствие человеческого фактора в создании номеров версий приводит к ошибкам в изменении версий. Например, разработчики могут изменить номер версии, даже если ни одна строчка кода не была переписана, чтобы создать ложное впечатление, что были внесены значительные изменения . [Электронный ресурс]

Конструкторская и инженерная деятельность мало чем отличается от разработки программного обеспечения, так что для эффективной работы и взаимодействия инженеров-конструкторов очень полезно позаимствовать опыт работы с версиями у программистов. Нижеописанные термины могут быть непонятны (незнакомы) и сложны в понимании для простого инженера, но это не означает что данные методы не будут работать в инженерно-конструкторской деятельности. Наоборот! Опыт который инженер-конструктор позаимствует у программиста, очень существенно повысит эффективность и качество работы инженера-конструктора.

Аксиомы работы с версиями конструкторских документов и изделий

  1. Проводник Windows имеет ограничение в 260 символов.
  2. Система разработки и постановки продукции на производство регулируется ГОСТ 15.000.
  3. Стадии разработки и присвоения  литеры регулируется ГОСТ 2.103.
    Документ ЛитераВерсия Этап
    Техническое предложение Пx.0.x Разработка технического предложения
    Эскизный проект Эx.1.x Разработка эскизного проекта
    Технический проект Тx.2.x Разработка технического проекта
    Рабочая конструкторская документация:
    опытного  образца (опытной партии) изделия, предназначенного для серийного (массового) или единичного производства (кроме разового изготовления) —x.3 Разработка конструкторской документации, предназначенная для изготовления и испытания опытного образца (опытной партии)
    О x.4Корректировка конструкторской документации по результатам изготовления и предварительных испытаний опытного образца (опытной партии)
    О1 x.5Корректировка конструкторской документации по результатам приемочных испытаний опытного образца (опытной партии)
    О2 x.6 Корректировка конструкторской документации по результатам изготовления и испытания опытного образца (опытной партии) для изделий, разрабатываемого по заказу Министерства обороны (при необходимости)
    серийного (массового) производства А x.7 Корректировка конструкторской документации по результатам изготовления и испытания установочной серии, а также оснащения технологического процесса изготовления изделия
    Б x.8Корректировка конструкторской документации по результатам изготовления и испытания головной (контрольной) серии для изделий, разрабатываемого по заказу Министерства обороны (при необходимости)
    изделия единичного производства, предназначенного для разового изготовления И.x Разработка конструкторской документации. Под разовым изготовлением понимается единовременное изготовление одного или более экземпляров изделия, дальнейшее производство которого не предусматривается

Шаблоны

  1. Название папки (репозитория) проекта
    Согласно аксиомам № 1, 2, 3 шаблон названия репо должен выглядеть следующим образом: ({литера}) {обозначение} {наименование} v{версия}
  2. Номер версии пишется согласно следующему правилу: {И|ИИ}.{Л|ЛЛ}.{В|ВВ}.{П|ПП}
    где:
    • И - итерация изделия (минимум 1 цифра, может занимать и больше разрядов);
    • Л - номер версии литеры изделия (минимум 1 цифра, может занимать и больше разрядов);
    • В - номер варианта версии изделия (минимум 1 цифра, может занимать и больше разрядов);
    • П - номер подверсии варианта изделия (минимум 1 цифра, может занимать и больше разрядов).
    Пример: 1.6.4.7 — 1-я итерация изделия, 6-я литера (версия-этап), 4-ой вариант, 7-я подверсия варианта.  
    Семантическое управление версиями, состоящее из трех частей
    Как это понимать? Допустим мы осваиваем производство нового продукта, тогда {Л|ЛЛ} = 0. Согласно аксиоме № 2 и 3, {Л|ЛЛ} = 0 – 8 (если изделие единичного производства то {Л|ЛЛ} пропускается, а {И|ИИ} пишется после точки . .

    Допустим на этапе Эскизного проекта наши идеи разделились на несколько вариантов, тогда {В|ВВ} будет соответствовать каждому отдельному варианту Эскизного проекта. Перейдя на этап Технический проект у нас есть пару мелких идей по корректировки изделия, тогда {П|ПП} будет соответствовать каждому отдельному варианту корректировки Технический проекта.

    В итоге мы получим следующую эволюцию версии изделия:
    • 0. — Абсолютно новое в производстве изделие;
      • 0.0. — Технического предложения нового изделия;
        • 0.0.1 — Первый вариант Технического предложения нового изделия;
          • 0.0.1.1 — Первая небольшая корректировка Первого варианта Технического предложения нового изделия;
          • 0.0.1.2 — Вторая небольшая корректировка первого варианта Технического предложения нового изделия;
        • 0.0.2 — Второй вариант Технического предложения нового изделия;
          • 0.0.2.1 — Первая небольшая корректировка Второго варианта Технического предложения нового изделия;
        • 0.0.3 — Третий вариант Технического предложения нового изделия;
      • 0.1. — Эскизный проект нового изделия;
        • 0.1.1.2 — Первый вариант Эскизного проекта разработанного из Второй небольшой корректировки первого варианта Технического предложения нового изделия;
        • 0.1.2.1 — Второй  вариант Эскизного проекта разработанного из Первой небольшой корректировки Второго варианта Технического предложения нового изделия;
          • 0.1.2.1.1 — Первая небольшая корректировка Второго варианта Эскизного проекта разработанного из Первой небольшой корректировки Второго варианта Технического предложения нового изделия;
            • 0.1.2.1.2 — Вторая небольшая корректировка Второго варианта Эскизного проекта разработанного из Первой небольшой корректировки Второго варианта Технического предложения нового изделия;
          • 0.1.3 — Третий  вариант Эскизного проекта разработанного из Третьего варианта Технического предложения нового изделия;
          • 0.1.4 — Четвертый вариант Эскизного проекта разработанного нового изделия;
            • 0.1.4.1 — Первая небольшая корректировка Четвертого варианта Эскизного проекта нового изделия;
      • 0.2. — Технический проект нового изделия;
        • 0.2.3 — Первый вариант Технического проекта разработанного из Третьего варианта Эскизного проекта разработанного из Третьего варианта Технического предложения нового изделия;
        • 0.2.4.1 — Второй вариант Технического проекта разработанного из Первой небольшой корректировки Четвертого варианта Эскизного проекта нового изделия;
        • 0.2.5 — Третий вариант Технического проекта нового изделия;
      • 0.3 — Рабочая конструкторская документация опытной партии нового изделия;
      • 0.4 — Корректировка Рабочей конструкторская документация опытной партии нового изделия по результатам изготовления и предварительных испытаний;
      • 0.5 — Корректировка Рабочей конструкторская документация опытной партии нового изделия по результатам приемочных испытаний;
      • 0.6 — Корректировка Рабочей конструкторская документация опытной партии нового изделия по результатам изготовления и испытания опытного образца (опытной партии) для изделий, разрабатываемого по заказу Министерства обороны (при необходимости);
      • 0.7 — Корректировка Рабочей конструкторская документация опытной партии нового изделия по результатам изготовления и испытания установочной серии, а также оснащения технологического процесса изготовления изделия;
      • 0.8 — Корректировка Рабочей конструкторская документация опытной партии нового изделия по результатам изготовления и испытания головной (контрольной) серии для изделий, разрабатываемого по заказу Министерства обороны (при необходимости);
    • 1. — Доработанное изделие исходя из опыта в производстве и эксплуатации потребителей;
      • 1.0.
        • 1.0.1
        • 1.0.2
        • 1.0.3
          • 1.0.3.1
          • 1.0.3.2
      • 1.1.
        • 1.1.1
          • 1.1.1.1
        • 1.1.2
      • 1.2.
        • 1.2.1.1
        • 1.2.2
        • 1.2.3
      • 1.3
      • 1.4
      • 1.5
      • 1.6
      • 1.8
    • 2. — Вторя версия изделия исходя из опыта в производстве и эксплуатации потребителей + изменение рынка;
    • 3. — Третья версия изделия исходя из опыта в производстве и эксплуатации потребителей + изменение рынка;
    Наиболее распространённый в настоящее время способ нумерации версий

Цифровые источники

Глоссарий

  • Репозиторий (репо) — место, где хранятся и поддерживаются какие-либо данные. Чаще всего данные в репозитории хранятся в виде файлов, доступных для дальнейшего распространения по сети. Место, где хранятся все Концепты (ГОСТ Р ИСО 20022-1-2013). Место, где хранятся и поддерживаются какие-либо данные вместе с историей их изменения и другой служебной информацией (ГОСТ Р 57723-2017).
  • Версия — версия это признак, присваиваемый документу и соответствующий определенной стадии разработки документа. Версии электронного документа отличаются друг от друга содержательной и/или реквизитной частью при неизменном обозначении документа. В бумажном КД все изменения, как правило, относятся к одному исходному документу, который также включает в себя все его предыдущие изменения. В такой системе управления документами порядковый номер изменения следует рассматривать как номер версии (ГОСТ 2.051-2013). Идентифицированный экземпляр информации (ГОСТ Р 57269-2016).
  • Вариант — одна из нескольких редакций какого-либо произведения (литературного, музыкального и тому подобного) или официального документа; видоизменение какой-либо части произведения (разночтения отдельных слов, строк, строф, глав). Предмет выбора или альтернатива, которые могут использоваться для реализации конкретных точек вариаций (ГОСТ Р ИСО/МЭК 26557-2019).
  • Вариация — вообще называется разновидность чего-либо, небольшое изменение или отклонение.
  • Точка вариаций — реализация, соответствующая конкретным переменным характеристикам продуктов, в контексте линейки продуктов. Примечание - Точки вариаций показывают, какой из элементов линейки продуктов изменяется. Каждая точка вариаций может иметь множественные связи (ГОСТ Р ИСО/МЭК 26557-2019).
  • Редакция — один из вариантов/версий правки/формулировки текста, доработанная по сравнению с предыдущей версия правил/закона (нередко называется «ревизия» — от «revision»; у компьютерных программ — версия). Разрешенная, "аккредитованная" версия объекта или модели.
  • Конфигурация — совокупность функциональных частей и связей между ними, обусловленная их техническими характеристиками. Взаимное расположение каких-либо предметов или соотношение отдельных частей сложных предметов внешнее очертание, форма, образ чего-либо остающиеся без изменений. Примечание - Конкретная конфигурация является результатом связывания точек вариации с отобранными вариантами (ГОСТ Р ИСО/МЭК 26557-2019).
{/literal}