3.5 Программы и программные документы спио

Разработка специального программного и информационного обеспечения проводится на основании технического задания по исходным данным, содержащимся в документах СПИО. Задание на программирование должно содержать описание алгоритмов, указание о конфигурации технических средств, языке программирования, операционной системе и соответствовать требованиям государственных стандартов ЕСКД. В зависимости от требований технического задания к составу разрабатываемого специального программного обеспечения АСУ ТП программные документы разрабатываются:

• на отдельные программы;

• на комплекс программ подсистемы и системы.

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

Спецификация - документ, состоящий из разделов: Документация и Программа. Наименование каждого раздела указывается в виде заголовка в графе Наименование и подчеркивается.

Документация - в зависимости от состава программного обеспечения АСУ ТП, на которое разрабатывается спецификация, записываются все программные документы, разработанные для отдельных программ, комплексов программ отдельных подсистем и системы в целом, начиная с программных документов на комплекс программ системы и завершая программными документами на отдельные программы. Программные документы на каждый комплекс или программу должны записываться в последовательности, в которой они перечислены. Программные документы записываются с указанием их обозначений наименований, количества тестов.

Таблица 3

Виды программных документов

Код вида документа	Вид документа	Отдельных программ	Комплекс программ
			Подсистемы	Системы
— 05 12 13 20 30 31 32 33 34 51 90	Спецификация Ведомость держателя подлинников Текст программы Описание программы Ведомость эксплуатационных документов Формуляр Общее описание Руководство системного программиста Руководство программиста Руководство оператора Порядок и методика испытания Документы прочие	0 — 0 0 + — — — + + + +	0 — 0 0 + + + + + 0 0 +	0 — 0 0 + + + + + 0 0 +

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

Ведомость держателя подлинников - документ специального программного обеспечения составляется на комплекс программ и программных документов АСУ ТП в целом на основании всех спецификаций на отдельные программы и комплексы программ системы и ее отдельных подсистем и программных документов на них.

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

Запись производится по разделам в следующей последовательности:

• программные документы на составные части;

• документы ссылочные.

Наименование разделов записывают в виде заголовков в графе Наименование и подчеркивают.

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

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

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

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

Графы ведомости держателей подлинников заполняют следующим образом:

в графе Обозначение указывают обозначение документа;

в графе Наименование:

для комплекта подлинников программных и ссылочных документов комплекса программ системы, на который составляется ведомость держателей подлинников, делают запись, например, по типу «Комплекс программ АСУ ТП прокатки толстолистового цеха. Комплект документов за исключением записанных ниже»;

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

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

Дату составления документа указывают в заголовке графы. Графу заполняют только для документов, подлинники которых хранятся на предприятии-держателе подлинника спецификации на комплекс программ системы. Последующие изменения количества листов в ведомость не вносят;

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

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

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

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

• наименование программы (полное и сокращенное);

• назначение, область применения и ограничения на применение программы;

• ссылку на рисунок, где показана схема программы;

• язык программирования (его описание при использовании специального языка);

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

• тип операционной системы, на работу с которой ориентирована программа;

• способ включения преграды (обращение к программе);

• условия настройки и запуска программы на выполнение;

• особые ситуации программы;

• время выполнения программы;

• объем памяти вычислительного комплекса, занимаемый программой;

• описание структуры массивов, используемых программой;

• описание входных, промежуточных и выходных параметров программы;

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

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

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

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

Ведомость эксплуатационных документов разрабатывается на отдельные программы или комплексы программ АСУ ТП в целом или ее отдельных подсистем. Эксплуатационные документы, разработанные для программ, записываются в следующем порядке:

на комплекс программ системы;

на комплексы программ ее отдельных подсистем;

на отдельные программы.

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

Формуляр - разрабатывается на комплексы программ АСУ ТП или отдельных ее подсистем, которые предполагается использовать в других АСУ ТП в качестве типовых и состоит из следующих разделов: общие указания, общие сведения, основные характеристики, комплектность поставки, свидетельство о приемке, гарантийные обязательства, сведения о рекламациях, сведения о хранении, сведения о закреплении при эксплуатации, сведения об изменениях, особые отметки.

Общие указания - приводятся общие рекомендации по применению программ на технологических объектах управления.

Общие сведения - приводятся:

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

назначение и краткая характеристика области применения программ с учетом как непосредственного назначения для конкретного объекта управления, так и возможного применения на других объектах;

наименование объекта, на котором внедрены программы в эксплуатацию;

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

прочие данные.

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

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

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

Гарантийное обязательство - приводится гарантийное обязательство организации разработчика специального программного обеспечения АСУ ТП.

Сведения о рекламациях - приводится краткое изложение порядка предъявления рекламации (оставляется место для регистрации всех предъявляемых рекламаций их содержания и принятым по ним мерам).

Сведения о хранении - приводятся данные об условиях хранения программ на машинных носителях информации.

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

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

Особые отметки - оставляются несколько чистых лепетов для специальных отметок, которые вносятся во время эксплуатации программ.

Общее описание - документ, разрабатываемый на комплексы программ АСУ ТП в целом или отдельных ее подсистем и содержащий:

• описание структуры, специального информационного обеспечения системы и (или) отдельных подсистем;

• структуру специального программного обеспечения системы и (или) отдельных подсистем;

• общий алгоритм функционирования системы и (или) ее отдельных подсистем:

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

Руководство системного программиста - документ, разрабатываемый на комплекс программ АСУ ТП в целом или на ее отдельные подсистемы, предназначенный для использования при работе по внесению изменений в информационное и программное обеспечения процессе эксплуатации системы или подсистемы на объекте. Он содержит:

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

• рекомендации по включению в подсистемы новых программ;

• рекомендации по включению, в систему новых подсистем;

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

Руководство программиста - документ, разрабатываемый на комплексы программ АСУ ТП в целом или ее отдельных подсистем и содержащий следующие сведения:

• перечень программ, включенных в состав программного обеспечения АСУ ТП или ее отдельных подсистем с указанием обозначений программ и их наименований;

• форматы обращений к программам на алгоритмических языках и (или) ассемблере;

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

• сведения о самонастраиваемости программ;

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

Руководство оператора - документ, разрабатываемый на Комплексы программ АСУ ТП в целом или ее отдельных подсистем и содержащий описания:

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

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

• действий оператора по первоначальной настройке программ на выполнение:

• действий оператора по первоначальному запуску программ на выполнение;

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

• действий оператора по перезапуску программ на выполнение при устранении причин отказов устройств;

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

Порядок и методика испытаний - документ, предназначенный для использования при проведении контрольных испытаний на объекте при их сдаче в опытную или промышленную эксплуатацию. Разрабатывается для комплекса программ АСУ ТП в целом или ее отдельных подсистем. Допускается разработка для контрольных испытаний при сдаче программ организации-заказчику на контрольных примерах, контрольных входных массивах, на данных от имитаторов датчиков технологических параметров и др.

Документ разрабатывается на основании технического задания на разработку специального программного и информационного обеспечения АСУ ТП и включает перечень вопросов, подлежащих проверке непосредственно на объекте при проведении испытаний.

Указанный документ не должен дублировать сведений, содержащихся в документе «Руководство оператора».

В документ должны быть включены следующие материалы:

• цель испытаний;

• перечень программ, представленных на испытания;

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

• краткое описание результатов выполнения программ:

• описание действий оператора по испытанию отдельных программ и комплексов программ отдельных подсистем и системы в целом в нормальных и ненормальных условиях эксплуатации;

• описание, реакции программ на ненормальные ситуации;

• продолжительность и режим испытания программ.

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

Документы прочие - все те программные документы, которые разрабатываются для отдельных программ и комплексов программ по усмотрению организации-разработчика специального программного обеспечения АСУ ТП:

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

Организация разработки основных документов. В зависимости от участия в разработке и внедрении АСУ ТП организации и предприятия могут выполнять функции:

1. Заказчика - юридического лица, финансирующего работы по созданию АСУ ТП и участвующего в указанных работах;

2. Исполнителя - юридического лица, выполняющего работы по созданию АСУ ТП в соответствии с договором, заключенным с организацией-заказчиком или другими действующими формами, предусматривающими оплату работ;

3. Соисполнителя - юридического лица, выполняющего часть работ по созданию АСУ TП по договору с организацией-исполнителем или организацией-заказчиком.

Заказчиком системы является организация или предприятие, для которого в соответствии с договором осуществляется разработка и внедрение АСУ ТП.

Организация-исполнитель АСУ ТП координирует работу организаций соисполнителей, выполняет функции заказчика по отношению к соисполнителям, а также отвечает перед заказчиком за технический уровень и качество разрабатываемой АСУ ТП.

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

Документы специального программного обеспечения АСУ ТП, разработанные три программам, удовлетворяющим требованиям технического задания, согласованию и утверждению в организации-заказчике не подлежат. Факт соответствия программ требованиям технического задания устанавливается в результате испытаний программ предусмотренных техническим заданием, и подтверждается двусторонним актом, утвержденным руководителями организации-заказчика и организации - разработчика специального программного обеспечения АСУ ТП.

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