ГОСТ 19. 402-78 ЕСПД. Описание программы

ГОСТ 19.105-78 ЕСПД. Общие требования к программным документам

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

o титульной;

o информационной;

o основной.

Правила оформления документа и его частей на каждом носителе данных устанавливаются стандартами ЕСПД на правила оформления документов на соответствующих носителях данных.

Титульная часть оформляется согласно ГОСТ 19.104-78.

Информационная часть должна состоять из аннотации и содержания. В аннотации приводят сведения о назначении документа и краткое изложение основной части. Содержание включает перечень записей о структурных элементах основной части документа.

Состав и структура основной части программного документа устанавливаются стандартами ЕСПД на соответствующие документы.

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

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

Техническое задание должно содержать следующие разделы:

o введение;

o основания для разработки;

o назначение разработки;

o требования к программе или программному изделию;

o требования к программной документации;

o технико-экономические показатели;

o стадии и этапы разработки;

o порядок контроля и приемки;

o в техническое задание допускается включать приложения.

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

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

Данный стандарт определяет состав и требования к содержанию программного документа «Описание программы». Описание программы включает:

1. Общие сведения.

2. Функциональное назначение.

3. Описание логической структуры.

4. Используемые технические средства.

5. Вызов и загрузка.

6. Входные данные.

7. Выходные данные.

В разделе Общие сведения указывают:

o обозначение и наименование программы;

o программное обеспечение, необходимое для функционирования программы;

o языки программирования, на которых написана программа.

Раздел Функциональное назначение должен отражать классы решаемых задач и/или назначение программы, сведения о функциональных ограничениях на применение.

При описании логической структуры должны быть отражены:

o алгоритм программы;

o используемые методы;

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

o связи программы с другими программами.

В разделе Используемые технические средства указывают типы ЭВМ и устройств, которые используются при работе программы.

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

Раздел Входные данные отражает:

o характер, организацию и предварительную подготовку входных данных;

o формат, описание и способ кодирования входных данных.

Раздел Выходные данные отражает:

o характер и организацию выходных данных;

o формат, описание и способ кодирования выходных данных.

ГОСТ 19.404-79 ЕСПД. Пояснительная записка. Требования к содержанию и оформлению

Согласно данному стандарту пояснительная записка должна включать следующие разделы:

1. Введение.

2. Назначение и область применения.

3. Технические характеристики.

4. Ожидаемые технико-экономические показатели.

5. Источники, использованные при разработке.

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

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

В разделе Технические характеристики содержатся:

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

o описание алгоритма и/или функционирования программы с обоснованием выбора схемы алгоритма решения задачи, возможного взаимодействия программы с другими программами;

o описание и обоснование выбора метода организации входных и выходных данных;

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

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

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

ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению

Руководство системного программиста должно содержать следующие разделы:

1. Общие сведения о программе.

2. Структура программы.

3. Настройка программы.

4. Проверка программы.

5. Дополнительные возможности.

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

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

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

В разделе Структура программы приводятся сведения о структуре программы, ее составных частях и связях с другими программами.

Раздел Настройка программы должен содержать описание действий по настройке программы на условия конкретного применения.

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

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

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

ГОСТ 19.504-79 ЕСПД. Руководство программиста. Требования к содержанию и оформлению

Руководство программиста должно содержать разделы:

1. Назначение и условия применения программы.

2. Характеристики программы.

3. Обращение к программе.

4. Входные и выходные данные.

5. Сообщения.

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

В разделе Характеристики программы необходимо привести описание основных характеристик и особенностей программы: временных характеристик, режима работы, средств контроля правильности выполнения и самовосстанавливаемости программы и т.д.

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

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

При описании сообщений необходимо привести тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действия, которые необходимо предпринять по этим сообщениям.

ГОСТ 19.505-79 ЕСПД. Руководство оператора. Требования к содержанию и оформлению

Руководство оператора должно включать:

1. Назначение программы.

2. Условия выполнения программы.

3. Выполнение программы.

4. Сообщения оператору.

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

Условия выполнения программы должны содержать условия необходимые для выполнения программы: минимальный и/или максимальный состав аппаратурных и программных средств.

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

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

ГОСТ 19.506-79 ЕСПД. Описание языка. Требования к содержанию и оформлению

При описании языка необходимо указать:

1. Общие сведения.

2. Элементы языка.

3. Кроме того, допускается вводить дополнительные разделы.

4. Способы структурирования программы.

5. Средства обмена данными.

6. Встроенные элементы.

7. Средства отладки программы.

Общие сведения должны содержать назначение и описание общих характеристик языка, его возможностей, основных областей применения и др.

В разделе Элементы языка приводят описание синтаксиса и семантики базовых и составных элементов языка.

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

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

В разделе Встроенные элементы описываются встроенные в язык элементы: функции, классы и т.д. и правила их использования.

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

Дата добавления: 2014-01-04