12.3 Программное обеспечение

12.3.1 Общие положения

12.3.1.1 Документация программного обеспечения предназначена:

• для описания проектных решений по программному обеспечению в документе «Описание программного

обеспечения АСУ».

• для установления требований к программе (комплексу программ) в документе «Техническое задание»;

• для описания решений, обеспечивающих сопровождение, изготовление и эксплуатацию программы (комплекса программ) в документах «Пояснительная записка», «Описание применения», «Описание программы», «Спецификация», «Руководство программиста», «Руководство оператора», «Текст программы», «Формуляр», «Порядок и методика испытаний»;

• для проверки работоспособности программы (комплекса программ) в документе «Описание контрольного примера».

12.3.1.2 При разработке документов на части АСУ содержание разделов каждого документа ограничивают рамками

соответствующей части.

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

Отсутствие проектных решений по разделу документа фиксируют в соответствующем разделе с необходимыми пояснениями.

12.3.1.4. Требования к содержанию документов «Техническое задание», «Пояснительная записка», «Описание применения», «Спецификация», «Руководство оператора», «Текст программы», «Формуляр», «Порядок и методика испытаний» установлены ГОСТ 19.201-78, ГОСТ 19.404-79, ГОСТ 19.502-78, ГОСТ 19.202-78, ГОСТ 19.505-79, ГОСТ 19.401-78, ГОСТ 19.501-78 и ГОСТ 19.301-79.

12.3.2. ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ

12.3.2.1. Описание программного обеспечения АСУ

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

• структура программного обеспечения;

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

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

• операционная система;

• средства, расширяющие возможности операционной системы.

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

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

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

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

Раздел «Операционная система» должен содержать:

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

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

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

Раздел «Средства, расширяющие возможности операционной системы» должен содержать подразделы, в которых для каждого используемого средства, расширяющего возможности операционной системы, следует указать:

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

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

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

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

Содержание документа должно соответствовать ГОСТ 19.402-78.

Для программы (комплекса программ), получаемой за счет использования ранее разработанных программных средств, документ «Описание программы» следует дополнять разделом «Настройка программных средств».

Раздел «Настройка программных средств» должен содержать:

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

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

• описание настройки на языке, предусмотренном в эксплуатационной документации на используемые программные средства.

12.3.2.3. Руководство программиста

Документ по составу разделов и их содержанию должен соответствовать ГОСТ 19.504-79 и, кроме того, включать раздел «Сведения о форме представления программы (комплекса программ)».

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

Для программы (комплекса программ), допускающей настройку на условия конкретного применения, в документ «Руководство программиста» включают разделы:

• структура программы;

• настройка программы;

• дополнительные возможности;

• сообщения системному программисту.

Содержание этих разделов должно соответствовать требованиям ГОСТ 19.503-79.

Разрешается для программы (комплекса программ), допускающей настройку на условия конкретного применения, вместо разделов, перечисленных в п. 2.3.3, разрабатывать отдельный документ «Руководство

системного программиста», удовлетворяющий требованиям ГОСТ 19.503-79.

12.3.2.4. Описание контрольного примера

Документ должен содержать разделы:

• назначение;

• исходные данные;

• результаты расчета;

• проверка программы (комплекса программ).

Раздел «Назначение» должен содержать перечень параметров и краткую характеристику функции, из числа реализуемых программой (комплексом программ), проверяемых контрольным примером.

Раздел «Исходные данные» должен содержать описание исходных данных для проверки программы (комплекса программ) с приведением исходных данных. Допускается исходные данные представлять в виде распечатки с АЦПУ.

Раздел «Результаты расчета» должен содержать результаты обработки исходных данных программой (комплексом программ), позволяющие оценить правильность выполнения проверяемых функции и значение проверяемых параметров. Допускается результаты расчета приводить в виде распечатки с АЦПУ.

Раздел «Проверка программы (комплекса программ)» должен содержать:

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

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

• описание действий оператора при подготовке исходных данных и проверке программы (комплекса программ) на контрольном примере.