Требования к содержанию и оформлению.
Руководство системного программиста должно содержать следующие разделы:
1. Общие сведения о программе.
2. Структура программы.
3. Настройка программы.
4. Проверка программы.
5. Дополнительные возможности.
6. Сообщения системному программисту.
При необходимости допускается опускать раздел, описывающий дополнительные возможности.
При описании общих сведений о программе необходимо указать назначение и функции программы и сведения о технических и программных средствах, обеспечивающих выполнение данной программы.
В разделе Структура программы приводятся сведения о структуре программы, ее составных частях и связях с другими программами.
Раздел Настройка программы должен содержать описание действий по настройке программы на условия конкретного применения.
При описании проверки программы необходимо привести и описать способы проверки, позволяющие дать общее заключение о работоспособности программы (контрольные примеры, методы прогона, результаты).
Раздел Дополнительные возможности должен содержать описание дополнительных разделов функциональных возможностей программы и способов их выбора.
В разделе Сообщения системному программисту необходимо указать тексты сообщений, выдаваемых в ходе выполнения программы, описание содержания и действий, которые необходимо предпринять по этим сообщениям.
ГОСТ 19.504-79 ЕСПД. Руководство программиста. Требования к содержанию и оформлению.
Руководство программиста должно содержать разделы:
1. Назначение и условия применения программы.
2. Характеристики программы.
3. Обращение к программе.
4. Входные и выходные данные.
5. Сообщения.
При описании назначения и условий применения программы необходимо указать назначение и функции, выполняемые программой; условия, необходимые для выполнения программы: объем оперативной памяти, требования к составу и параметрам перифирийных устрайств; требования к ПО и т.д.
В разделе Характеристики программы необходимо привести описание основных характеристик и особенностей программы: временных характеристик, режима работы, средств контроля правильности выполнения и самовосстанавливаемости программы и т.д.
Раздел Обращение к программе представляет собой описание процедур вызова программы (способов передачи управления и параметров данных и др.).
Раздел Входные и выходные данные должен содержать описание
организации используемой входной и выходной информации и при необходимости ее кодирования.
При описании сообщений необходимо привести тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действия, которые необходимо предпринять по этим сообщениям.
ГОСТ 19.505-79 ЕСПД. Руководство оператора. Требования к
Содержанию и оформлению.
Руководство оператора должно включать:
1. Назначение программы.
2. Условия выполнения программы.
3. Выполнение программы.
4. Сообщения оператору.
При описании назначений программы необходимо указать сведения о назначении программы и информацию, достаточную для понимания функций программы и ее эксплуатации.
Условия выполнения программы должны содержать условия, необходимые для выполнения программы: минимальный и/или максимальный состав аппаратурных и программных средств.
В разделе Выполнение программы необходимо указать последовательность действий оператора, обеспечивающих загрузку, запуск выполнение и завершение программы; привести описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды.
При описании сообщений оператору приводят тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора: действия в случае сбоя, возможности повторного запуска программы и т.д.
