6. Описание содержания разделов документа «Текст программы».

6.1. Обозначение документа «Текст программы» производится согласно п.2.3 настоящего МП:

КП.ЯП.2203.XX.YY.ОБНАЗ 12

где 12 – код документа ПЗ.

6.2. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105 – 75 и ГОСТ 19.104 – 78.

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

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

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

6. Описание содержания разделов документа «Руководство пользователя».

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

- назначение программы;

- условия выполнения программы;

- выполнение программы;

- сообщение пользователю.

7.2. Содержание документа определяется ГОСТ 19.505-79.

7.3. В разделе «Назначение программы» должны быть указаны сведения, необходимые для эксплуатации программы.

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

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

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

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

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

8. Описание содержания разделов документа «Руководство программиста».

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

- установочные параметры программы;

- порядок разработки программы;

- характеристики программы;

- обращение к программе;

- сообщения;

- приложения.

8.2. Структура, оформление и содержание документа должны устанавливаться по ГОСТ 19.504-79.

8.3. В разделе «Назначение и условия применения программы» должны быть указаны: цели, основные задачи, назначения и функции, выполняемые программой, условия, необходимые для выполнения программы (минимальная конфигурация ЭВМ, объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программному обеспечению и т.п.); полная информация о всех возможных вариантах работы программы.

8.4. В разделе «Характеристики программы» должны быть приведены описание основных характеристик и особенности программы (тип носителя информации, временные характеристики, режим работы, средств контроля правильности выполнения, самовосстанавливаемость программы и т.п.); детальное изложение языковых средств, служащих для описания данных и запросов на обработку; описание исходных, промежуточных и основных массивов обрабатываемых и составляемых программой; организация и обновление массивов данных; сведения о процедурах работы с данными.

8.5. В разделе «Обращение к программе» должно быть приведено описание процедуры вызова программы (способы передачи управления и параметров данных и др.).

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