Программный документ Спецификация

Ответы на ряд вопросов можно получить, прочитав ГОСТ Р ИСО 9127-94. СОИ. Документация пользователя и информация на упаковке для потребительских программных пакетов.

Предположение !!!
Так как ТЗ на программный продукт, то
1) СП в соответствии с требованиями ЕСПД.
2) ПО на носителе данных (лучше, если тип носителя определен в ТЗ, наверно . Пример, некоторые промышленные системные блоки не имеют CD(DVD)-приводов, но зато есть USB).

Посмотрите ГОСТ 2.418, мне кажется, Вы найдете там ответ.

А зачем?

Основным продуктом нашей организации традиционно являются "железные" изделия с загруженным в него программным обеспечением.
И поэтому проблем и вопросов по разработке перечня разрабатываемой документации на такого рода изделия давно нет.

Но вот сегодня обратились ко мне с таким вопросом.
Получено ТЗ на разработку программного изделия. Нужно разработать перечень разрабатываемой документации.

Изделие - программный продукт. При подготовке к поставке должно быть записано на носитель типа CD. Упаковано в железную коробку и уложено в деревянную тару. На тару должны быть нанесены этикетки.
Понятно, что СП на продукт должно разрабатываться в соответствии с требованиями ЕСПД. Упаковки разрабатываются по ЕСКД.
Вопрос - Правомочно ли будет в СП на программное изделие в раздел Комплекты включать конструкторский документ - СП на упаковку и комплект этикеток?

Я свожу эту проблему к решению вопросу - Что продается ПО на диске или диск с ПО ?

И ответ мой таков - Продается то, что будет эксплуатироваться.
Т.Е. - если ПО, то должна быть разработана СП как программный документ с включением в него конструкторских документов на упаковку и т.д.
А если ДИСК с ПО (допустим в роли блестящей подставки или как отражатель )
то СП - конструкторский документ с включением в раздел Комплекты как Упаковки так и ПО, а в раздел Прочие - CD диск.

И еще - Почему в конструкторской СП есть графа - Формат, а в СП как программный документ - нет :roll: ?
Какую роль выполняю в конструкторской СП сведения о формате документа? Особенно в свете электронного документооборота.
Ненужно ли ввести в СП на ПО сведения о формате данных на ПО ?

А может и в конструкторской СП вместо А4, А3 и т.д. записывать *.doc, *.dwg, и.т.п

С этим утверждением полностью согласен.
У нас так и принято. Обозначение СП на ПО (например - АБВГ.12345-01 Программное обеспечение для блока ГК) записывают в раздел "Комплекты"
При этом ПО - как составная часть железа записывают в СП железа, а
ПО - выполняющее функции вспомогательные, тестовые (в процессе регулирования и контроля железа), записывают в Комплекты аппаратуры для испытаний на предприятии-изготовителе. А сам Комплект аппаратуры для испытаний на предприятии-изготовителе в Примечания - в конце СП, т.к. он не есть составная часть изделия и заказывается по мере необходимости.

Т.К. у нас архив электронный (один на все) то в нем хрянятся и документы ЕСКД, ЕСПД, ЕСТД, и программные изделия, и электронные модели печатных плат, деталей, сборочных единиц, данные для проетирования ПЛИС. Вообщем все.
От архива на носителях мы отказались лет 10 назад.
ПО записываем на носители только в случае прямой поставки, или в комплекте ЗИП (для восстановления).

Я бы рассмотрел этот вопрос шире. Есть два понятия — программный продукт и программный документ.

Программный продукт = программное обеспечение (ПО) — это собственно программа, интеллектуальная собственность, нематериальный актив. Программный продукт (software) в аппаратно-программном комплексе — равноправная по отношению к аппаратуре (hardware) составная часть комплекса. ПО имеет право находиться в спецификации изделия под своим названием и под своим децимальным номером наравне с «железом». В спецификации на изделие ПО записывается в раздел «Комплексы» или «Комплекты», в зависимости от того, выполняет ли оно определяющие, т.е. управляющие, или вспомогательные, т.е. сервисные функции.

Программный документ (ПД) по отношению к программному продукту эквивалентен конструкторскому документу (КД) по отношению к «железу». И КД, и ПД записываются в разделе «Документация» спецификации на изделие.

Отдельный вопрос с материальным носителем информации, на котором ПО записано. Проведем аналогию с ПЛИС. Непрошитая микросхема аналогична «болванке» CD. Непрошитая ПЛИС может быть записана в спецификацию изделия отдельной строкой только с децимальным номером изготовителя. Прошитая ПЛИС должна быть записана в спецификацию уже с децимальным номером предприятия, осуществившего прошивку. То же самое и с CD, на котором записано ПО. Запись примерно такого содержания: «Компакт-диск с программным обеспечением НННННН УЖАС.ХХХХХХ.ХХХ», где УЖАС относится к предприятию, разработавшему ПО, а ХХХХХХ берется из раздела «Носители информации» общероссийского классификатора (компакт-диски). Эта запись просится в раздел «Прочие изделия» спецификации. Действительно, основную ценность имеет само ПО, а CD с ПО является вспомогательным изделием.

Для учета числа экземпляров поставленного ПО в паспорт изделия можно вписывать заводской номер изготовленного предприятием компакт-диска с программным обеспечением.

В ТЗ указываю ТРЕБОВАНИЯ к файлу, его назначение. Степень детализации этого описания может быть любая - от фразы "Файл предназначен для запуска... блаблабла" до описания его разработки.
В перечень оборудования включаю диск с файлом.

Liss
Мы тоже по требованию заказчика сдаем их на носителях как ПО.
Но это не дело! Происходит подмена понятий. В итоге исходный текст остается не документирован.

surgeon, пойду там пообщаюсь.

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

А почему просто дамп не распечатать в рамках? Подобный вопрос, кстати, обсуждался в форуме electronix.ru

DGroot

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

Но как быть в такой ситуации: есть микропроцессорная система, для производства(!) которой необходим микрокод (бинарник).
Т.е. бинарник должен входить в состав КД, разве не так?

В виде какого документа мы можем оформить тогда программу?

А исходный текст на нее?

Если вернуться в прошлый век (туда откуда родом ГОСТы 19.ХХХ) мы увидим что программные документы и сами программы в силу естественных причин хранились отдельно друг от друга (в разных помещениях, на разных полках). И никаких проблем по управлению и тем и другим на всех этапах их жизненного цикла не возникало.
Очевидно что изменение текста программы являлось первопричиной замены самой программы.
Вернувшись в наше время, как следствие вышесказанного, напрашивается вывод о возможности создания двух схем:
- два электронных арихива (один для программных документов, другой для программ) формально разнесенных друг от друга.
- один электронный архив в котором хранится и то и другое рядом.

Я согласен с Вами Liss, что вполне логично оформить как приложение к тексту программы саму программу (т.к. они жестко связаны друг с другом). Однако как тогда соблюдать требования ГОСТа по обозначению программ и программых документов.

Если быть законопослушным то надо четко соблюдать требования поставленной задачи. А условия задачи определены в ГОСТ 19.103-77.

Мы в своей организации пытались решить эту проблему приняв условие, что программы - программые документы и присваивая им обозначение по структуре программных документов используя коды для прочих документов (90-99) и вписывая их в спецификацию в раздел документация. Это конечно чистой воды отступление от требований ГОСТ 19.103-77 и вызвано было непродуманностью тех кто принимал это решение.

Выводы получаюся следующие.
Для реализации требований ГОСТ 19.103-77, ГОСТ 19.101-77, ГОСТ 19.202-78 в полном объеме необходимо, в зависимости от тех или иных условий ведения архивного хозяйства разрабатывать соответствующие правила управления программами и программными документами на всех этапах жизненного цикла. Иначе на просторах нашей родины воцарится анархия.

Думаю уместно будет сказать, что одной из задач этого ФОРУМа есть и будет:
1 Поиск тех методик и технологических решений который позволют соблюдать требования НТД в условия изменяемости аппаратно-программных комплексов.
2 Образовывать молодых специалистов.
3 Оказывать влияние на содержание действующих и вновь разрабатываемых НТД.
(Что то потянуло на потетику )

Может быть стоило их оформить как приложения к основному тексту програмы. Ведь сами по себе они большой роли не имеют, скорее всего они идут как "дополнительные" документы, может поэтому не стоит из них делать самостоятельные?

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

5 Изменения
Корректировка должна производится по следующей методике
5.1 При корректировке спецификации (как документа), в следствии изменения состава программных документов, содержание извещения должно быть следующее "Листы 1 – 3 заменить."
5.2 При корректировке программы, в следствии изменения текста программы, содержание извещения должно быть следующее "Программное обеспечение заменить" или "Программу заменить".
5.3 При одновременной корректировке того и другого, содержание извещения должно быть следующее
АБВГ.ХХХХХ-01 заменить
либо одновременно
Листы 1 – 3 заменить.
Программное обеспечение заменить
6 Согласование
При согласовании соответствующих программных документов, подпись, поставленная по спецификацией будет означать и согласование самой программы.

1 Обозначение
1.1 В соответствии с ГОСТ 19.103-77 "Обозначения программ и программных документов" структура обозначения программы и ее программного документа – спецификации должно быть одно и тоже т.е.
АБВГ.ХХХХХ-ХХ.
1.2 Структура обозначения программных документов включает (в дополнение к выше приведенному) также:
- код вида документа
- номер документа данного вида
- номер части документа

2 Виды программ и программных документов
2.1 В соответствии с ГОСТ 19.101-77 "Виды программ и программных документов" программы делятся на Компоненты и Комплексы, а программные документы включаю:
- спецификацию
- текст программы
- описание программы
- руководство по ………
и т.д.
При этом каждый программный документ имеет соответствующий код вида документа.
Таким образом, ГОСТ четко разделяет понятия программа и программный документ.

3 Спецификация
В ГОСТ 19.202-78 "Спецификация. Требования к содержанию и оформлению" указано, что в разделах:
"Документация " – указываются обозначения записываемых программных документов.
"Комплексы" – обозначения спецификаций комплексов, входящих в данный комплекс.
"Компоненты" – обозначения основных программных документов компонентов.
При этом исходя из таблицы 4 ГОСТ 19.101 видим, что основными (обязательными) программными документами являются Спецификация и Текст программы. Таким образов в разделе "Компоненты" могут быть представлены либо обозначение спецификации (самой программы – компонента при отсутствии спецификации), либо текста программы на соответствующий компонент.

С чего бы вдруг?

В разделе «Компоненты» записывают обозначения основных программных документов компонентов. Никто не может запретить вписать туда бинарники как документ "Текст программы".

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

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

А в какое место? Казалось бы в раздел "Компоненты". Но по 19.202 туда надо записывать обозначения основных программных документов, т.е. или спецификацию или текст программы. Бред какой-то! По этому госту получается, что в программных изделиях исполняемого кода нет?!

Бинарные файлы и прочие дампы пропишите в той же спецификации.