ГОСТ 19.505-79
Группа Т55
МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ
Единая система программной документации
РУКОВОДСТВО ОПЕРАТОРА
Требования к содержанию и оформлению
Unified system for program documentation. Operation’s guide. Requirements for contents and form of presentation
МКС 35.080
Дата введения 1980-01-01
Постановлением Государственного комитета CCCР по стандартам от 12 января 1979 г. N 74 дата введения установлена 01.01.80
ИЗДАНИЕ (январь 2010 г.) с Изменением N 1, утвержденным в сентябре 1981 г. (ИУС 11-81).
Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство оператора», определенного ГОСТ 19.101-77.
Стандарт полностью соответствует СТ СЭВ 2096-80*.
(Измененная редакция, Изм. N 1).
1. ОБЩИЕ ПОЛОЖЕНИЯ
1.1. Структура и оформление программного документа устанавливаются в соответствии с ГОСТ 19.105-78.
Составление информационной части (аннотации и содержания) является обязательным.
1.2. Руководство оператора должно содержать следующие разделы:
назначение программы;
условия выполнения программы;
выполнение программы;
сообщения оператору.
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.
(Измененная редакция, Изм. N 1).
2. СОДЕРЖАНИЕ РАЗДЕЛОВ
2.1. В разделе «Назначение программы» должны быть указаны сведения о назначении программы и информация, достаточная для понимания функций программы и ее эксплуатации.
2.2. В разделе «Условия выполнения программы» должны быть указаны условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратурных и программных средств и т.п.).
2.3. В разделе «Выполнение программы» должны быть: указана последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы, приведены описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды.
2.2, 2.3. (Измененная редакция, Изм. N 1).
2.4. (Исключен, Изм. N 1).
2.5. В разделе «Сообщения оператору» должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора (действия оператора в случае сбоя, возможности повторного запуска программы и т.п.).
2.6. Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками.
(Измененная редакция, Изм. N 1).
2.7. В приложения к руководству оператора допускается включать различные материалы, которые нецелесообразно включать в разделы руководства.
(Введен дополнительно, Изм. N 1).
(по ГОСТ 19.505-79. ЕСПД. Руководство оператора. Требования к содержанию и оформлению)
Настоящий стандарт устанавливает требования к
содержанию и оформлению программного документа «Руководство оператора», определённого ГОСТ 19.101-77. Структуру и оформление документа устанавливают в
соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и
содержания) является обязательным.
==================================
Скачать пример оформления
A.B.00001-01 34 01 (Руководство оператора) (пример — .pdf) |
514 137 b | Загрузить |
A.B.00001-01 34 01 (Руководство оператора) (шаблон — .dot) |
17 902 b | Загрузить |
На верх
==================================
Рекомендуемая структура программного документа (по ГОСТ 19.505-79. ЕСПД)
- Лист утверждения
- Титульный лист
- Аннотация
- Содержание
- Основная часть
- Назначение программы
- Функциональное назначение программы
- Эксплуатационное назначение программы
- Состав функций
- Функции (такой-то)
-
Функции (этакой)
- Условия выполнения программы
- Минимальный состав аппаратных средств
- Минимальный состав программных средств
- Требования к персоналу (пользователю)
- Выполнение программы
- Загрузка и запуск программы
- Выполнение программы
- Выполнение функции (такой-то)
- Выполнение функции (этакой)
- Завершение работы программы
- Сообщения оператору
- Сообщение (такое-то)
- Сообщение (этакое)
- Приложения (необязательны)
- Регистрация изменений
На верх
==================================
<Предыдущий>
<Содержание>
Требования к структуре руководства оператора по ГОСТ 19 устанавливаются ГОСТ 19.505. В общем случае документ должен состоять из следующих разделов:
1. Назначение программы
2. Условия выполнения программы
3. Выполнение программы
4. Сообщения оператору
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.
Примечание
Эти и другие требования к структуре и содержанию руководства оператора по ГОСТ 19 подробнее см. ГОСТ 19.505
Документ оформляется в соответствии с правилами предусмотренными ГОСТ 19.105, ГОСТ 19.106 и другими стандартами Единой системы программной документации (ЕСПД).