5.3.4.Требования к содержанию документов с решениями по программному обеспечению

Состав документов по программному обеспечению АС определяют ГОСТ 34.201-89 (Виды, комплектность и обозначение документов при создании автоматизированных систем) и ГОСТ 19.101-77, регламентирующий виды документов на программные средства, используемые при создании АС.

Документы по программному обеспечению АС можно разделить на четыре группы: 1) для описания проектных решений по программному обеспечению; 2) для установления требований к программе или комплексу программ; 3) для описания решений, обеспечивающих сопровождение, изготовление и эксплуатацию программы или комплекса программ; 4) для проверки работоспособности программы или комплекса программ (см. рис 5.1).

1. К первой группе относится документ «Описание программного обеспечения». Этот документ, согласно ГОСТ 34.201-89, разрабатывается на стадии «Технический проект». Его состав определен РД 50-34.698-90.

Документ состоит из следующих шести разделов:

1. «Вводная часть», где содержатся основные сведения об АС, необходимые для разработки программного обеспечения;

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

3. «Функции частей программного обеспечения», этот раздел состоит из подразделов, в каждом из которых приводится назначение и описание основных функций соответствующей части;

4. «Методы и средства разработки программного обеспечения», где дается перечень методов программирования и средств разработки программного обеспечения АС с указанием частей программного обеспечения, при разработке которых использовались эти методы и средства;

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

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

. Вторая группа состоит из одного документа, определяющего требования к программе или комплексу программ, - «Техническое задание».

Этот документ составляют в соответствии с ГОСТ 19.201-78 (ЕСПД. Техническое задание. Требования к содержанию и оформлению).

«Техническое задание» содержит следующие разделы: 1) введение; 2) основание для разработки; 3) назначение разработки; 4) требования к программной документации; 5) технико-экономические показатели; 6) стадии и этапы разработки; 7) порядок контроля и приемки.

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

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

Р ис. 5.1. Документы по программному обеспечению

характеристикам и т.д.); 2) требования к надежности (т.е. требования к обеспечению устойчивого функционирования, контролю входной и выходной информации, времени восстановления после отказа и т.д.); 3) требования к эксплуатации, в том числе составу и параметрам технических средств; 4) требования к информационной и программной совместимости; 5) требования к маркировке, упаковке, транспортировке и хранению, другие требования.

. Третья группа документов по ПО посвящена описанию проектных решений по сопровождению, изготовлению и эксплуатации программы или комплекса программ. К этой группе относят документы: 1) «Пояснительная записка»; 2) «Описание применения»; 3) «Описание программы»; 4) «Спецификации»; 5) «Руководство программиста»; 6) «Руководства оператора»; 7) «Текст программы»; 8) «Формуляр»; 9) «Порядок и методика испытаний». Рассмотрим наиболее важные из них.

1. Документ “Пояснительная записка” составляется в соответствии с ГОСТ 19.404-79. Он содержит следующие разделы: 1) введение; 2) назначение и область применения; 3) технические характеристики; 4) ожидаемые технико-экономические показатели; 5) источники, использованные при разработке. Наиболее объемным является раздел “Технические характеристики”, в котором содержатся следующие подразделы: 1) постановка задачи, описание применяемых математических методов, допущений и ограничений, связанных с выбранным математическим аппаратом; 2) описание алгоритма и (или) функционирования программы с обоснованием выбора схемы алгоритма, возможные взаимодействия программы с другими программами; 3) описание и обоснование выбора метода организации входных и выходных данных; 4) описание и обоснование выбора состава технических и программных средств, распределение носителей данных, которые использует программа.

2Документ “Описание применения” составляется в соответствии с ГОСТ 19.502-78. Он содержит разделы: назначение программы; условия применения; описание задачи; входные и выходные данные.

1. В разделе “Назначение программы” указывают назначение и возможности программы, ее основные характеристики и ограничения, накладываемые на область применения.

2. В разделе “Условия применения” приводят требования к необходимым для данной программы техническим средствам и другим программам, общие характеристики входной и выходной информации, требования и условия организационного, технического, технологического и др. Характера.

3. В разделе “Описание задачи” указывают определение задачи и методы ее решения.

4. В разделе “Входные и выходные данные” приводят сведения о входных и выходных данных.

3Документ “Описание программы” составляется с требованиями ГОСТ 19.402-78. Если программа или комплекс программ получена за счет использования ранее разработанных программных средств, то этот документ дополняют разделом “Настройка программных средств”. Согласно ГОСТ 19.402-78, документ “Описание программы” должен содержать следующие семь разделов: 1) общие сведения; 2) функциональное назначение; 3) описание логической структуры; 4) используемые технические средства; 5) вызов и загрузка; 6) входные данные; 7) выходные данные. В зависимости от особенностей разработанной программы, допускается вводить дополнительные разделы, либо объединять отдельные разделы.

1. В разделе “Общие сведения” указывают обозначение и наименование программы, программное обеспечение, необходимое для функционирования программы, языки программирования.

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

3. Раздел “Описание логической структуры” содержит: алгоритм программы; используемые методы; структуру программы с указанием связей между ее элементами; связи программы с другими программами. Этот раздел выполняют с учетом текста программы на исходном языке.

4. Раздел “Используемые технические средства” содержит сведения о типе ЭВМ или других устройств.

5. В разделе “Вызов и загрузка” указывают способ вызова программы с соответствующего носителя данных, входные точки в программу. Возможно указание адресов загрузки, сведений об использовании оперативной памяти, объеме программы.

6. – 7) В разделах “Входные данные” “Выходные данные” указывают характер, организацию, формат, описание и способ кодирования входных (выходных) данных. Для входных данных еще указывают их предварительную подготовку, если она есть.

4Документ “Руководство программиста” по составу разделов и их содержанию, должен соответствовать ГОСТ 19.504-79. Он содержит следующие разделы: 1) назначение и условия применения программы; 2) характеристики программы; 3) обращение к программе; 4) входные и выходные данные; 5) сообщения; 6) сведения о форме представления программы. В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.

1. В разделе “Назначение и условия применения программы” указывают назначение и функции, выполняемые программой, условия ее выполнения (объем оперативной памяти, требования к составу и параметрам периферийных устройств, программному обеспечению и т.п.).

2. В разделе “характеристики программы” приводят описание основных характеристик и особенностей программы (временные характеристики, режим работы, средства контроля правильности выполнения и т.п.).

3. В разделе “Обращение к программе” приводят описание процедур вызова программы (способы передачи управления и параметров данных).

4. В разделе “Входные и выходные данные” приводят описание организации используемой входной и выходной информации и, при необходимости, ее кодирования.

5. В разделе “Сообщения” указывают тексты сообщений, выдаваемых пользователю в ходе выполнения программы, описание их содержания и действия, которые необходимо предпринимать по этим сообщениям.

6. Кроме указанных разделов документ “Руководство программиста” должен включать раздел “Сведения о форме представления программы (комплекса программ)”. В этом разделе даются сведения о носителе, на котором записана программа, о содержании и системе кодирования информации, записанной на носителе, сведения, необходимые для чтения информации с носителя.

Если программа (комплекс программ) допускает настройку на условия конкретного применения, то в документ “Руководство программиста” дополнительно включают разделы: структура программы; настройка программы; дополнительные возможности; сообщения программному программисту. Содержания этих разделов должно соответствовать требованиям ГОСТ 19.503-79 (Руководство системного программиста. ЕСПД). Согласно этому ГОСТу в разделе “Структура программы” приводятся сведения о структуре программы, ее составных частях и связях между ними и с другими программами.

В разделе “Настройка программы” приводят описание действий по настройке программы на условия конкретного применения (настройка на состав технических средств, выбор функций и др.).

В разделе “Дополнительные возможности” дают описание дополнительных разделов функциональных возможностей программы и способов их выбора.

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

Требования к документам “Спецификация”, “Руководство оператора”, “Текст программы”, “Формуляр”, “Порядок и методика испытаний” приведены в ГОСТ 19.202-78, ГОСТ 19.505-79, ГОСТ 19.401-78, ГОСТ 19.501-78, ГОСТ 19.301-79.

4. Четвертую группу документов по ПО составляют документы, содержащие проектные решения, обеспечивающие проверку работоспособности программы или комплекса программ, содержатся в документе «Описание контрольного примера» ГОСТ 24.207-80. Этот документ состоит из следующих разделов:

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

2. «Исходные данные», в котором приводится описание исходных данных для проверки программы и сами исходные данные;

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

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