Единая система программной документации. Руководство оператора. Требования к содержанию и оформлению

МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ

Единая система программной документации

РУКОВОДСТВО ОПЕРАТОРА

Требования к содержанию и оформлению
Unified system for program documentation. Operation's guide. Requirements for contents and form of presentation ГОСТ
19.505-79

Постановлением Государственного комитета СССР по стандартам от 12 января 1979 г. № 74 дата введения установлена
01.01.80
Издание с Изменением № 1, утвержденным в сентябре 1981 г. (ИУС 11-81).
Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа "Руководство оператора", определенного HYPERLINK "5458.htm" \o "Единая система программной документации. Виды программ и программных документов" ГОСТ 19.101-77 .
Стандарт полностью соответствует СТ СЭВ 2096-80.
(Измененная редакция, Изм. № 1).

1. ОБЩИЕ ПОЛОЖЕНИЯ

1.1. Структура и оформление программного документа устанавливаются в соответствии с HYPERLINK "5468.htm" \o "Единая система программной документации. Общие требования к программным документам" ГОСТ 19.105-78 .
Составление информационной части (аннотации и содержания) является обязательным.
1.2. Руководство оператора должно содержать следующие разделы:
назначение программы;
условия выполнения программы;
выполнение программы;
сообщения оператору.
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.
(Измененная редакция, Изм. № 1).

2. СОДЕРЖАНИЕ РАЗДЕЛОВ

~
`
b
~
€
æ
€
„
ed¥u¢
ed¥u¢
ed¥u¢
ed¥u¢
ed¥u¢
ed¥u¢
it¥u¢
ed¥u¢
„
æ
ed¥u¢
ed¥u¢
сведения о назначении программы и информация, достаточная для понимания функций программы и ее эксплуатации.
2.2. В разделе "Условия выполнения программы" должны быть указаны условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратурных и программных средств и т. п.).
2.3. В разделе "Выполнение программы" должны быть: указана последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы, приведены описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды.
2.2, 2.3. (Измененная редакция, Изм. № 1).
2.4. (Исключен, Изм. № 1).
2.5. В разделе "Сообщения оператору" должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора (действия оператора в случае сбоя, возможности повторного запуска программы и т. п.).
2.6. Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками.
(Измененная редакция, Изм. № 1).
2.7. В приложения к руководству оператора допускается включать различные материалы, которые нецелесообразно включать в разделы руководства.
(Введен дополнительно, Изм. № 1).