Гост для руководства оператора

ГОСТ 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).

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

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

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

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

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

• сообщения
  оператору.

В
зависимости от особенностей ПС в
документе допускается объединять
отдельные разделы или вводить новые.

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

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

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

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

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

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

6.19. Гост 19.508. Руководство по техническому обслуживанию. Требования к содержанию и оформлению

Настоящий
стандарт распространяется на тестовые
и диагностические программы, используемые
при обслуживании технических средств.

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

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

• введение;

• общие
  указания;

• требования
  к техническим средствам;

• описание
  функций;

В
зависимости от особенностей ПС в
документе допускается вводить
дополнительные разделы.

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

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

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

В
разделе «Описание функций» указывают:

• максимальный
  состав технических средств, проверяемых
  этой программой;

• описание
  совместного функционирования технических
  средств и программы с указанием метода
  обработки ошибок;

• описание
  организации входных и выходных данных,
  используемых при обслуживании технических
  средств;

• описание
  взаимодействий устройств с программой,
  результатов взаимодействий, с выводом
  результатов работы программы.