Оформление программных документов - по ГОСТ 19.105-78 и ГОСТ 19.106-78.
Титульная часть программных документов состоит иэ листа утверждения и титульного листа. Оформление их производится в соответствии с ГОСТ 19.104-78 с учетом правил, установленных в организациях-разработчиках.
Титульный лист составляют на каждый программный документ. Лист утверждения допускается выпускать только на спецификацию.
Обозначение программ и программных документов - поГОСТ 19,103-77 и ГОСТ 23501.119-83 (для программного обеспечения САПР). Код организации- разработчика - по общесоюзному классификатору предприятий, организаций и учреждений.
Сопроводительная документация содержит следующие документы:
копию акта межведомственных (ведомственных) приемочных испытаний ПС;
акт о проведении опытной эксплуатации ПС;
акт экспертизы материала, подготовленного к публикации;
информационную каргу Государственного фонда алгоритмов и программ (ГОСФАП);
справку о фактических затратах на разработку ПС;
справку об устранении недостатков, отмеченных в акте межведомственных (ведомственных) испытаний ПС;
акт о. внедрении ПС.
|
ОСТ 1 02575-86 Стр. 7 16. Акт межведомственных (ведомственных) приемочных испытаний ПС под- гверждаег работоспособность ПС и их соответствие ТЗ, содержит рекомендации по устранению выявленных недостатков ПС и включению их в ГОСФАП. Оформление акта межведомственных (ведомственных) приемочных испытаний приведено в рекомендуемом приложении 2. - 17. Акт о проведении опытной эксплуатации ПС содержит сведения о выпои- ненных работах на этапе опытной эксплуатации и обнаруженных в ПС ошибках и недостатках. Оформление акта б проведении опытной эксплуатации ПС приведено в рекомендуемом приложении 3.
Та блица 3 |
|||
|
Сопроводительный документ |
Разработка ПС |
||
|
по плану Министерства (ведомства) или вышестоящей организации |
по плану предприятия |
вне плана |
|
|
Копия акта межведомственных (ведомственных) приемочных испытаний Акт о проведении опытной эксплуатации |
• |
© |
О |
Инв. № дубликата № изм.
Инв. Ns подлинника 5428' № изв
|
|
|
ОСТ 1 02575-86 Стр. 8 Продолжение табл. 3 |
|||
|
|
|
||||
|
|
|
Сопроводительный документ |
Разработка ПС |
||
|
по плану Министерства (ведомства) или вышестоящей организации |
по плану предприятия |
вне вплана |
|||
|
|
|
||||
|
Акт экспертизы материала, подготовлен- ного к публикации Информационная карта ГОСФАП Справка.о фактических затратах на разработку ПС Справка об устранении недостатков |
• • о Предоставляют при наличии недостатков, отмеченных в акте приемочных испытаний |
• Q |
• • |
||
|
|
|
||||
|
|
|
||||
|
|
|
||||
|
|
|
||||
|
|
|
||||
|
Примечания: 1. Допускается вместо акта о проведении опытной эксплуага- ции представлять акт о внедрении ПС.
. Условные обозначения: ф - документ, обязательный для представления в ОФАП ф - документ представляют по согласованию с ОФАП |
|||||
|
|
|
||||
|
|
|
||||
|
N° изм. |
№ изв. |
||||
документ не представляют.
|
|
5428 |
|
Инв. № дубликата |
Инв. Ne подлинника |
Hub. № дубликата N° изм.
Инв. Ns подлинника 5428 № изв.
ПРИЛОЖЕНИЕ 1
Рекомендуемое
СОСТАВ И СОДЕРЖАНИЕ ОБЪЕДИНЕННЫХ
ПРОГРАММНЫХ ДОКУМЕНТОВ
. 1. В общем случае в целях сокращения избы точности информации и удобства пользования программной, документацией различных категорий специалистов (руководителей, инженеров, программистов) рекомендуется объединять в основном программном документе "Описание применения" сведения, из всех видов эксплуатацией- . ных документов и документации для сопровождения.
В конкретных случаях в. зависимости от особенностей ПС, условий их эксплуатации и сопровождения допускается объединять в документе "Описание при-, менения" сведения из части этих видов документов.
Требования к содержанию и оформлению необъединенных программных документов - по стандартам ЕСПД.
Структура .и оформление объединенного документа "Описание применения" . ' по ГОСТ 19.105-78.
Составление информационной части, ('аннотации и содержания) является обязательным. '
5. Разделы, основной части объединенного документа "Описание применения" условно разбиваются на три главы, следующие в порядке:
глава экспресс-информации; -
глава эксплуатационная;
глава сопровождения. .
Глава экспресс-информации состоит из раздела "Паспорт описания" и содержит краткое изложение возможностей ПС и условий его применения.
Разделы эксплуатационной главы должны содержать сведения, дополняющие содержание "Паспорта описания" так, чтобы первые две главы содержали всю информацию, необходимую, для эксплуатации ПС.
Разделы главы сопровождения должны содержать сведения, необходимые для модификаций ПС, обусловленных необходимостью внесения изменений.
Раздел "Паспорт описания" может выполняться на специальном бланке,
И на. Я; дубликата № изм. Инв. Ns подлинника 5428 Ns изв. Данные раздела |
Пояснения |
|
Индексы УДК |
Рекомендуется использовать подразделы основного индекса 519.68 - программирование на ЭВМ. Подразделение по тематике задач производится при помощи знака *:* |
|
Регистрационный номер ОФ АП |
|
|
Ключевые слова |
Указываются ключевые слова, характеризующие тематику задач, методы.решения, область применения / |
|
Идентификатор программного средства |
Имя программного средства и его, псевдоним |
|
Название программного средства |
Должно отражать содержание задачи |
|
Тип ЭВМ |
'■ — |
|
Операционная система |
|
|
Языки программирования |
Перечень языков, на которых написано ПС |
|
Версии трансляторов - |
' - _• ■ |
|
Необходимые ресурсы ЭВМ ... . |
Объем и тип оперативной и внешней памяти, специальные устройства |
|
Оценки времени |
Данные, позволяющие оценить время решения задач |
|
Объем программного средства... в операторах исходного языка. |
|
|
Документация |
Перечисляются виды программных документов или приводится литература, в которой содержится информация, дающая полное представление о методах и алгоритмах, реализо- . ванных в программном средстве |
|
Примечание |
Приводится прочая информация, не вошедшая в *Паспорт описания* |
Таблица 1
10.2. Специфические для различных категорий ПС данные раздела "Паспорт описания" приведены в табл. 2.
|
Категория ПС |
Данные раздела |
Пояснения |
|
Подпрограмма |
Обращение |
Указывается форма обращения к подпрограмме |
|
Общие блоки |
Перечисляются имена общих блоков памяти; непомеченный блок обозначается знаком *//" |
|
|
Вызываемые подпрограммы |
Перечисляются имена подпрограмм, вызываемых данных с указанием содержащих их библиотек, если они не совпадают с именем ПС, включающих описываемую подпрограмму |
|
|
Описание параметров |
Перечисляются имена и содержательные наименования входных и выходных параметров. Для случаев, когда "Паспорт описания" является единственным разделом в "Описании применения", сведения о параметрах должны быть исчерпывающими |
|
|
Компонент-программа |
Метод решения |
Кратко описывается математическая постановка задачи и приводится краткая характеристика методов решения |
|
Пределы применяемости |
Указываются ограничения на применение использованных методов, характеристика точности решения и ограничения по ресурсам ЭВМ |
|
|
Входные, выходные данные |
Перечисляются множества исходных данных и результатов с указанием их физического смысла и носителей |
|
|
Используемые подпрограммы, библиотеки, базы данных |
Перечисляются имена подпрограмм, библиотек и. баз данных, используемых программой |
|
|
Предшествующие ПС |
Перечисляются имена ПС, являющихся базовыми для формирования входных данных программы |
|
|
Последующие ПС |
Перечисляются ПС, в которых используются (или могли бы использоваться) результаты программы |
|
|
'1 . |
||
Инв. № дубликата № изм.
Инв. Ns подлинника . 5428 № изв.
Таблица 2
|
Категория ПС |
Данные раздела |
Пояснения |
|
Библиотека под- программ- |
Перечень разделов |
Для библиотек сложной организации, для которых целесообразно разделение всей библиотеки на тематические разделы, перечисляются наименования разделов |
|
Классифицированный перечень подпрограмм |
Даются сведения по тематическим разделам о их составе |
|
|
Комплекс программ |
Используемые библиотеки Л |
Перечисляются имена внешних по отношению к ПС библиотек и баз данных, используемых в процессе работы программ данного комплекса’ |
|
Перечень программ |
Даются сведения о составе программ и библиотек, входящих, в комплекс программ |
|
|
ПП с СВЯ |
Характеристики входного языка пакета |
Кратко описывается тип языка (процедурный, непроцедурный), возможности его расширения, типы операторов и обрабатываемых данных |
|
Характеристики средств реализации входного языка |
— |
|
|
Тип |
Указываются тип средств реализации (компилятор, интерпретатор и т.п.) и базовые средства поддержки, если они использовались при создании средств реализации |
|
|
Выходной язык |
Указывается язык, на котором собирается текст программы, являющейся результатом обработки задания на входном языке |
|
|
Объем оперативного запоминающего устройства (ОЗУ) |
Указывается объем ОЗУ, занимаемый средствами реализации |
|
|
Методы решений |
Кратко характеризуются методы решений, реализованные в функциональной части пакета |
|
|
Библиотеки |
Перечисляются имена библиотек и комплексов программ, в которых размещаются средства пакета, и имена библиотек, не входящих, но используемых на некоторых стадиях работы |
