Как записать программу в спецификации

Спецификация является основным программным документом для компонентов, применяемых самостоятельно, а также для комплексов.

Требования к содержанию и оформлению спецификации устанавливает ГОСТ 19.202-78.

Форма спецификации программы приведена в приложении Ж.

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

• документация;
• комплексы;
• компоненты.

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

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

Коды вида документов приведены в ГОСТ 19.101-77.

После каждого раздела спецификации необходимо оставлять несколько свободных строк для дополнительных записей.

Графы спецификации заполняют следующим образом.

Спецификация

В графе «Обозначение» указывают:

— в разделе «Документация» – обозначения записываемых документов программы;

— в разделе «Комплексы» – обозначения спецификаций комплексов, входящих в данный комплекс;

— в разделе «Компоненты» – обозначения основных программных документов компонентов.

В графе «Наименование» указывают:

• в разделе «Документация» – наименование и вид документа для документов на данную программу, полное наименование программы, наименование и вид документа для заимствованных документов;
• в разделах «Комплексы» и «Компоненты» – полное наименование программы, наименование и вид документа.

В графе «Примечание» – дополнительные сведения, относящиеся к записанным в спецификации программам.

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

6.5 Текст программы

Требования к содержанию и оформлению программного документа «Текст программы» устанавливает ГОСТ 19.401-78.

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

Основная часть документа должна состоять из текстов одного или нескольких разделов, которым даны наименования. Допускается вводить наименование также и для совокупности разделов. Каждый из этих разделов реализуется одним из типов символической записи, например:

• символическая запись на исходном языке;
• символическая запись на промежуточных языках;
• символическое представление машинных кодов и т. п.

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

Спецификация I-TOOLS часть №1

6.6 Описание программы

Состав и требования к содержанию программного документа «Описание программы» устанавливает ГОСТ 19.402-78.

Составление информационной части (аннотации и содержания) является обязательным.

Описание программы должно содержать следующие разделы:

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

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

В разделе «Общие сведения» должны быть указаны:

— обозначение и наименование программы;

— программное обеспечение, необходимое для функционирования программы;

— языки программирования, на которых написана программа.

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

В разделе «Описание логической структуры» должны быть указаны:

• алгоритм программы;
• используемые методы;

— структура программы с описанием функций составных частей и связи между ними;

• связи программы с другими программами.

Описание логической структуры программы выполняют с учетом текста программы на исходном языке.

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

В разделе «Вызов и загрузка» должны быть указаны:

• способ вызова программы с соответствующего носителя данных;
• входные точки в программу.

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

В разделе «Входные данные» должны быть указаны:

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

В разделе «Выходные данные» должны быть указаны:

• характер и организация выходных данных;
• формат, описание и способ кодирования выходных данных.

Источник: studfile.net

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

разработка техдокументации по ГОСТ без бумаги и расстояний

СПЕЦИФИКАЦИЯ по ГОСТ 19.202-78 (пример, образец)

Спецификация. Лист утверждения 1)

по ГОСТ 19.104-78

Текст программы 2)

по ГОСТ 19.401-78

NU.УЖОС.13666-13 12 01-ЛУ

Лист утверждения 2)

по ГОСТ 19.402-78

NU.УЖОС.13666-13 13 01-ЛУ

Лист утверждения 1)

по ГОСТ 19.507-79

NU.УЖОС.13666-13 20 01-ЛУ

документов. Лист утверждения 1)

по ГОСТ 19.502-78

NU.УЖОС.13666-13 31 01-ЛУ

Лист утверждения 1)

по ГОСТ 19.503-79

NU.УЖОС.13666-13 32 01 01-ЛУ

Лист утверждения 1)

по ГОСТ 19.504-79

NU.УЖОС.13666-13 33 01-ЛУ

Лист утверждения 1)

по ГОСТ 19.505-79

NU.УЖОС.13666-13 34 01 01-ЛУ

Лист утверждения 1)

NU.УЖОС.13666-13 35 01

по ГОСТ 19.506-79

NU.УЖОС.13666-13 35 01 01-ЛУ

Лист утверждения 1)

NU.УЖОС.13666-13 46 01

Руководство по техническому

по ГОСТ 19.508-79

NU.УЖОС.13666-13 46 01 01-ЛУ

Руководство по техническому

Лист утверждения 1)

Программа и методика

по ГОСТ 19.301-79

NU.УЖОС.13666-13 51 01-ЛУ

Программа и методика

испытаний. Лист утверждения 1)

по ГОСТ 19.404-79

NU.УЖОС.13666-13 81 01-ЛУ

Лист утверждения 1)

NU.УЖОС.13666-13 90 (П4) 01

Лист утверждения 1)

NU.УЖОС.13666-13 91 (ТЭО) 01-ЛУ

Лист утверждения 1)

1. Размножать по особому указанию.
2. Документ выполнен на компакт-диске.

• Спецификация ☠ Пример ☠ Образец

Источник: tdocs.su

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

В ГОСТ 19.202 фигурируют только программные документы. А куда прописать бинарники?

• Войдите на сайт для отправки комментариев
• 4800 просмотров

Пт, 03/23/2007 — 12:23
Программный документ Спецификация

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

Когда нет знания, есть мнение.

• Войдите на сайт для отправки комментариев

Пт, 03/23/2007 — 10:44
Программный документ Спецификация

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

Правомочно ли будет в СП на программное изделие в раздел Комплекты включать конструкторский документ

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

Ненужно ли ввести в СП на ПО сведения о формате данных на ПО ?

• Войдите на сайт для отправки комментариев

Пт, 03/23/2007 — 02:00
Программный документ Спецификация

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

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

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

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

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

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

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

• Войдите на сайт для отправки комментариев

Сб, 03/17/2007 — 02:24
Программный документ Спецификация

В спецификации на изделие ПО записывается в раздел «Комплексы» или «Комплекты», в зависимости от того, выполняет ли оно определяющие, т.е. управляющие, или вспомогательные, т.е. сервисные функции.

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

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

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

• Войдите на сайт для отправки комментариев

Пт, 03/16/2007 — 14:25
Программный документ Спецификация

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

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

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

Отдельный вопрос с материальным носителем информации, на котором ПО записано. Проведем аналогию с ПЛИС. Непрошитая микросхема аналогична «болванке» CD. Непрошитая ПЛИС может быть записана в спецификацию изделия отдельной строкой только с децимальным номером изготовителя.

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

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

Когда нет знания, есть мнение.

• Войдите на сайт для отправки комментариев

Пт, 03/16/2007 — 08:49
Программный документ Спецификация

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

• Войдите на сайт для отправки комментариев

Чт, 03/15/2007 — 17:44
Программный документ Спецификация

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

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

• Войдите на сайт для отправки комментариев

Чт, 03/15/2007 — 17:36
Программный документ Спецификация

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

Длинная дорога начинается с первого маленького шага.

• Войдите на сайт для отправки комментариев

Чт, 03/15/2007 — 17:06
Программный документ Спецификация

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

• Войдите на сайт для отправки комментариев

Чт, 03/15/2007 — 16:59
Программный документ Спецификация

Вернувшись в наше время, как следствие вышесказанного, напрашивается вывод о возможности создания двух схем:
— два электронных арихива (один для программных документов, другой для программ) формально разнесенных друг от друга.

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

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

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

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

• Войдите на сайт для отправки комментариев

Сб, 02/17/2007 — 14:23
Программный документ Спецификация

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

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

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