5.7. Описание применения

Документ включает следующие разделы основной части, содержащие необходимую информацию:

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

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

описание задачи – определения решаемых задач, применяемые методы их решения;

входные и выходные данные – структурная организация и форматы представления входных и выходных данных.

5.8. Руководство системного программиста

Документ включает следующие разделы основной части, содержащие необходимую информацию:

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

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

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

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

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

Документ включает следующие разделы основной части, содержащие необходимую информацию:

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

характеристики программы – описание временных характеристик, режимов работы и других особенностей программы (например, средства самоконтроля и самовосстановления);

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

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

5.10. Руководство оператора

Документ включает следующие разделы основной части, содержащие необходимую информацию:

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

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

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

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

Графические программные документы выполняют в соответствии с ГОСТ 19.701-90.

6.1. Виды графических программных документов

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

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

• схема данных – отображает путь данных при решении задач, определяет этапы обработки и применяемые носители данных;

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

Термин «схема программы» тождественен термину «схема алгоритма программы». Не допускается использование термина «блок-схема алгоритма».