О программах и программных документах программного обеспечения автоматизированных систем
Разработка специального программного и информационного обеспечения приводиться на основании технического задания по исходным данным, содержащимся в документах СПИО. Задание на программирование должно содержать описание алгоритмов, указание о конфигурации технических средств, языке программирования, операционной системе стандартов ЕСПД.
В зависимости от требований технического задания к составу разрабатываемого специального программного обеспечения автоматизированных систем программные документы разрабатываются:
- на отдельные программы;
- на комплекс программ подсистемы и системы.
Виды программных документов следующие:
Спецификация - документ, состоящий из разделов: Документация и Программа. Наименование каждого раздела указывается на стадии заголовка в графе Наименование и подчеркивается.
Документация - в зависимости от состава программного обеспечения систем автоматизации, на которое разрабатывается спецификация, записываются все программные документы, разработанные я отдельных программ, комплексов программ отдельных подсистем и системы в целом, начиная с программных документов на комплекс программ системы и завершения программными документами на отдельные программы. Программные документы на каждый комплекс или программу должны записываться в последовательности, в которой они перечислены. Программные документы записываются с указанием их назначений, наименований, количества тестов.
Программа - записываются все программы на машинных носителях информации в порядке возрастания их регистрационных номеров и номеров частей программ, указанных в обозначениях программ. Программы записываются с указанием их обозначений и наименований. При этом в спецификацию не включаются программы, которые относятся к общему программному обеспечению управляющего вычислительного комплекса 9машины) проектируемой АСУ ТП. В этом же разделе записываются программы в состав комплексов программ отдельных подсистем, а также отдельные программы, не вошедшие ни в один из перечисленных комплексов.
Ведомость держателя подлинников - документ специального программного обеспечения-составляется на комплекс программ и программных документов автоматизированных систем в целом а основании всех спецификаций на отдельные программы и комплексы программ системы и ее отдельных подсистем и программных документов на них.
В начале ведомости записывают программные документы, подлинники которых хранятся в организации-держателе подлинника спецификации на комплекс программ системы. Далее записывают программные документы, подлинники которых хранятся в других организациях.
Запись производится по разделам в следующей последовательности: программные документы на составные части; документы ссылочные.
Наименование разделов записывают в виде заголовков в графе Наименование и подчеркивают.
Программные документы на составные части - указываются спецификации составных частей специального программного обеспечения (отдельных программ, комплексов программ, отдельных подсистем) без перечисления входящих в них программных и ссылочных документов.
Комплекс подлинников программных и ссылочных документов, хранящихся в организации-держателе подлинника спецификации на комплекс программ системы, записывают за обозначением спецификации на комплекс программ системы. Запись должна быть первой в этом разделе документа. Затем записывают документы на отдельные подсистемы и отдельные программы системы в порядке возрастания обозначений.
Документы ссылочные - записываются в порядке возрастания обозначений, примененные из других систем. Графы ведомости держателей подлинников заполняют следующим образом:
- в графе Обозначение указывают обозначение документа;
- в графе Наименование:
для комплекта подлинников программных и ссылочных документов комплекса программ системы, на который составляется ведомость держателей подлинников, делают запись, например, по типу «Комплекс программ АСУ ТП фабрики. Комплект документов за исключением записанных ниже»;
для документов на составные части специального программного обеспечения приводят наименование составной части в соответствии с наименованием, указанным в основной надписи спецификации на составную часть системы (на программу, на комплекс программ подсистемы);
для документов ссылочных приводят полное наименование ссылочного документа;
в графе Количество листов указывают количество листов в комплекте документа на день составления ведомости держателей подлинников. Дату составления документов указывают в заголовке графы. Графы заполняют только для документов, подлинники которых хранятся на предприятии-держателе подлинника спецификации на комплекс программ системы. Последующие изменения количеств листов в ведомость не вносят;
в графе Держатель подлинники указывают ведомственную принадлежность (министерство) и в установленном порядке наименование организации-держателя подлинника. При записи организацией-держателей подлинников, относящихся к одному ведомству (министерству), в двух и более последующих строках одного листа ведомости наименование ведомства (министерства) указывают только при первом упоминании и в дальнейшем не повторяют.
в графе Примечание указывают, при необходимости, дополнительные сведения.
Текст программы (Тексты программ) - документ, разрабатываемый на отдельную программу или комплексы программы систем управления технологическими процессами в целом или ее отдельных подсистем и содержащий машинные распечатки программ (листинги) на алгоритмическом языке или машинно-ориентированном языке, которые использовались при разработке программ системы. При этом в документы не включают листинги программ, входящих в состав общего программного обеспечения вычислительных комплексов АСУ ТП, не используемых в системе. В случае применения программ, разработанных для других систем, в документ должны включаться их машинные распечатки (листинги) и должны содержаться ссылки на документы, содержащие их описания.
Описание программы (Описание программ) - документ, разрабатываемый на отдельные программы или комплексы программ систем управления технологическими процессами в целом или ее отдельных подсистем и содержащий схему каждой программы, описание программы по схеме и ее машинной распечатке (листинге), описание входных, промежуточных и выходных информационных массивов, общих для нескольких программ, с указанием элементов используемых массивов. Описание каждой программы рекомендуется оформлять в виде раздела программного документа, который должен содержать следующие сведения:
- наименование программы (полное или сокращенное);
- назначение, область применения и ограничения на применение программы
- ссылку на рисунок, где показана схема программы;
- язык программирования (его описания при использовании специального языка);
- описание конфигурации вычислительного комплекса с указанием используемых программой устройств (модулей) вычислительного комплекса;
- тип операционной системы, на работу с которой ориентирована программа;
- способ включения программы (обращение к программе);
- условия настройки и запуска программы на выполнение;
- особые ситуации программы;
- время выполнения программы;
- объем памяти вычислительного комплекса, занимаемой программой;
- описание структуры массивов, используемых программой;
- описание входных, промежуточных и выходных параметров программ;
- описание форм выходных документов или сообщений, если они формируются программой;
- дополнительные сведения о программе по усмотрению разработчика.
При этом степень детализации схем программ должна быть такой, чтобы однозначно и полно отображать все функции (операции) программы и последовательность их выполнения, быть достаточной для понимания способа реализации алгоритма программным путем.
Требования к описанию программ контрольных примеров, используемых для проверки правильности функционирования программ, идентичны требованиям к описанию программ системы.