Лекция Программная и эксплуатационная документация

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

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

Согласно стандарту ГОСТ 19.301-79 «ЕСПД. Программа и методика испытаний. Требования к содержанию и оформлению»
1. Программа и методика испытаний.
2. Описание программы.
3. Пояснительная записка.
4. Текст программы.
5. Описание применения.

В этом разделе указываются:
- наименование, область применения и обозначение испытуемого ПК;
-цель проведения испытаний;
- технические требования к программной документации и техническим характеристикам;
- порядок проведения испытаний (содержит последовательность испытаний, состав и структура технических средств);

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

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

В этом разделе указываются:
- приводится запись программ на исходных языках, сопровождаемая необходимыми комментариями;
-

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

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

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

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