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

Содержание программного документа «Описание программы» определенно ГОСТ 19.101-77. В соответствии с этим подраздел Описание программы раздела Рабочий проект должен содержать:

- общие сведения;

- функциональное назначение;

- описание логической структуры;

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

- вызов и загрузка;

- входные данные;

- выходные данные.

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

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

- язык программирования, используемый для составления программы. Чем продиктован выбор языка программирования (доступностью того или иного транслятора или другими факторами);

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

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

- характер и уровень использования аппаратных, средств - центральных и периферийных.

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

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

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

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

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

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

В пункте "вызов и загрузка" должны быть указаны:

- способ вызова программы с соответствующего носителя данных;

- входные точки в программу.

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

В пункте "входные данные" должны быть указаны:

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

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

В пункте "выходные данные" должны быть указаны:

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

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

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

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

4.5.2.3 Контрольный пример

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

Подраздел Контрольный пример должен включать следующие пункты:

- назначение, основные функции;

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

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

- проверка программы.

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

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

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

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

4.5.2.4 Руководство оператора (пользователя)

Структура и оформление программного документа «Руководство оператора (пользователя)» устанав­ливаются в соответствии с ГOCT 19.105 - 78. Руководство оператора должно содержать:

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

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

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

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

Допускается содержание подраздела иллюстрировать поясняю­щими примерами, таблицами, схемами, графиками.