Что такое руководство оператора
Разработка руководства оператора ГОСТ
Руководство оператора ГОСТ чаще всего рассматривается как документ, в котором указаны конкретные действия оператора. Основная задача оператора – в режиме «on-line» осуществлять обслуживание системы или программного обеспечения входящего в систему, поэтому руководство оператора частично объединяет в себе информацию, предназначенную для пользователя и администратора системы (программы).
Типовая структура руководства оператора регламентируется ГОСТ 19.505-79 и включает: 
Назначение программы Условия выполнения программы Выполнение программы Сообщения оператору
В зависимости от особенностей допускается вводить новые разделы или объединять существующие.
По своему изложению руководство оператора должно содержать минимально необходимую информацию, обеспечивающую нормальный режим работы оператора. В документе должно быть минимальное количество, а в идеале вообще не должно быть разделов содержащих теоретический материал не несущий никакой смысловой нагрузки.
С примером структуры руководства для оператора разработанного нашими специалистами Вы можете ознакомиться в разделе портфолио.
Если Вам нужно разработать и написать руководство оператора удовлетворяющего всем требованиям стандартов, то обратитесь к нам по телефону +7(499)755-74-33, электронной почте Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра. или через форму заказа.
С целью персонализации сервисов, повышения удобства пользования веб-сайтом и проведения статистических исследований мы используем файлы «cookie». «Cookie» представляют собой небольшие файлы, содержащие информацию о настройках браузера. Продолжая использовать наш сайт, вы даете согласие на обработку файлов cookie, если вы не хотите использовать файлы «cookie», измените настройки браузера.
Техническая документация
разработка техдокументации по ГОСТ
Как писать руководство оператора по ГОСТ 19.505-79?
Создан 16.02.2010 19:41:18
Структура разделов руководства оператора по ГОСТ 19.505-79 приведена ниже.
Составление информационной части (аннотации и содержания) является обязательным [из 1.1 ГОСТ 19.505-79]
В аннотации целесообразно привести следующую фразу: «Настоящее руководство распространяется исключительно на программу и не заменяет учебную, справочную литературу, руководства от производителя ОС и прочие источники информации, освещающие работу с графическим пользовательским интерфейсом операционной системы». Допустимо создание подраздела «Назначение руководства» или «Рекомендации по освоению».
Состав руководства
Руководство оператора должно содержать следующие разделы:
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые [из 1.2 ГОСТ 19.505-79]
Последняя фраза предоставляет разработчикам программной документации пространство для маневра.
Назначение программы
В разделе «Назначение программы» должны быть указаны сведения о назначении программы (1.1) и информация, достаточная для понимания функций программы и ее эксплуатации (1.2) [из 2.1 ГОСТ 19.505-79]
«. должны быть указаны сведения о назначении программы». Сведения о назначении программы изложены в основополагающем документе – в техническом задании.
Функциональное назначение
Функциональным назначением программы является предоставление пользователю возможности работы с текстовыми документами в формате rtf.
Эксплуатационное назначение
Программа должна эксплуатироваться в профильных подразделениях на объектах заказчика.
Пользователями программы должны являться сотрудники профильных подразделений объектов заказчика.
Состав функций
Программа обеспечивает возможность выполнения перечисленных ниже функций:
Условия выполнения программы
В разделе «Условия выполнения программы» должны быть указаны условия, необходимые для выполнения программы (2.1) (минимальный и (или) максимальный состав аппаратурных (2.2) и программных средств (2.3) и т.п.) [из 2.2 ГОСТ 19.505-79]
Создаем соответствующие подразделы. Поскольку «аппаратурных» звучит старообразно, меняем его на «технических».
Климатические условия эксплуатации
Климатические условия эксплутатации, при которых должны обеспечиваться заданные характеристики, должны удовлетворять требованиям, предъявляемым к техническим средствам в части условий их эксплуатации.
Минимальный состав технических средств
В состав технических средств должен входить IBM-совместимый персональный компьютер (ПЭВМ), включающий в себя:
Минимальный состав программных средств
Системные программные средства, используемые программой, должны быть представлены лицензионной локализованной версией операционной системы. Допускается использование пакета обновления такого-то.
Требования к персоналу (пользователю)
Минимальное количество персонала, требуемого для работы программы, должно составлять не менее 2 штатных единиц – системный администратор и пользователь программы – оператор.
Системный администратор должен иметь высшее профильное образование и сертификаты компании-производителя операционной системы. В перечень задач, выполняемых системным администратором, должны входить:
Пользователь программы (оператор) должен обладать практическими навыками работы с графическим пользовательским интерфейсом операционной системы.
Персонал должен быть аттестован на II квалификационную группу по электробезопасности (для работы с конторским оборудованием).
Выполнение программы
В разделе «Выполнение программы» должна быть указана последовательность действий оператора, обеспечивающих загрузку (3.1), запуск (3.2), выполнение (3.3) и завершение программы (3.6), приведено описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузки и управляет выполнением программы (3.4), а также ответы программы на эти команды (3.5) [из 2.3 ГОСТ 19.505-79]
Автоматически, «пальцами», создаем подразделы:
Загрузка и запуск программы
Загрузка и запуск программы осуществляется способами, детальные сведения о которых изложены в руководстве пользователя операционной системы.
В случае успешного запуска программы на рабочем столе будет отображено Главное окно программы.
Выполнение программы
«В подразделе следует привести «описание функций, формата и возможных вариантов команд, с помощью которых оператор … управляет выполнением программы».
Выше был приведен перечень функций, возможность выполнения которых обеспечивает программа. Для каждой функции из перечня следует создать подраздел.
Выполнение функции создания нового (безымянного) файла
Выполнение указанной функции возможно любым из перечисленных ниже способов:
В случае успешного выполнения указанной функции на рабочем столе будет отображено окно (см. Загрузка и запуск программы). Программа готова к вводу и редактированию текста.
Выполнение функции открытия (загрузки) существующего файла
Выполнение указанной функции возможно любым из перечисленных ниже способов:
В случае успешного (выполнения программой функции) открытия файла на рабочем столе будет отображено окно с содержимым открытого (текущего) файла. Заголовок Главного окна программы будет отображать полный путь текущего файла.
Выполнение функции редактирования текущего файла путем ввода, замены, удаления содержимого файла с применением устройств ввода
Предполагается, что операции нетривиальны, специфичны для предметной области и никаких сведений об их выполнении в руководстве пользователя операционной системы нет и быть не может принципиально. Поэтому простые и привычные операции будут расписаны детально.
Редактирование текущего файла путем ввода текста с устройств ввода
Последовательность действий, требуемая для выполнения указанной операции, включает в себя:
Для пометки стартовой позиции редактирования следует переместить курсор в требуемую позицию текста и нажать левую клавишу мыши. В требуемой позиции будет отображен курсор.
Далее следует вводить (набирать) требуемый текст с клавиатуры. По мере ввода символов изображение курсора будет смещаться вправо.
Редактирование текущего файла путем замены содержимого с применением устройств ввода
Последовательность действий, требуемая для выполнения указанной операции, включает в себя:
Для выделения текста, подлежащего замене, следует:
Фрагмент текста будет выделен цветом.
Далее следует вводить требуемый текст с клавиатуры. Выделенный фрагмент текста будет удален. По мере ввода символов изображение курсора будет смещаться вправо.
Редактирование текущего файла путем удаления содержимого с применением устройств ввода
Последовательность действий, требуемая для выполнения указанной операции, включает в себя:
Детальные сведения о способах выделения текстового фрагмента изложены во втором абзаце п. Редактирование текущего файла путем замены содержимого с применением устройств ввода.
Удаление может быть выполнено любым из перечисленных ниже способов:
Выполнение функции редактирования текущего файла с применением буфера обмена операционной системы
Указанная функция включает в себя перечисленные ниже операции:
Выполнение операции копирования (фрагмента) файла
Последовательность действий, требуемая для выполнения указанной операции, включает в себя:
Детальные сведения о способах выделения текстового фрагмента изложены во втором абзаце п. Редактирование текущего файла путем замены содержимого с применением устройств ввода. По завершении выделения фрагмента кнопка копирования примет вид 
.
Выполнение указанной операции возможно любым из перечисленных ниже способов:
В результате выполнения указанной операции выделенный фрагмент текста текущего файла будет помещен в буфер обмена операционной системы.
Выполнение операции вставки содержимого буфера обмена в файл
Последовательность действий, требуемая для выполнения указанной операции, включает в себя:
Для пометки стартовой позиции вставки следует переместить курсор в требуемую позицию текста и нажать левую клавишу мыши. В требуемой позиции будет отображен курсор.
Выполнение указанной операции возможно любым из перечисленных ниже способов:
В результате выполнения указанной операции фрагмент текста, содержащегося в буфере обмена, будет помещен в требуемую позицию текущего файла.
Выполнение функции сохранения файла с исходным именем
Выполнение указанной функции возможно любым из перечисленных ниже способов:
Выполнение функции сохранения файла с именем, отличным от исходного
Наверное, достаточно. Нет смысла дублировать (фактически) описания выполнения типовых функций программы в учебно-тренировочном документе.
Завершение работы программы
Завершение работы программы обеспечиваются стандартными средствами операционной системы.
Выполнение указанной функции возможно любым из перечисленных ниже способов:
Сообщения оператору
В разделе «Сообщения оператору» должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы (4.1), описание их содержания и соответствующие действия оператора (4.2) (действия оператора в случае сбоя (4.3), возможности повторного запуска программы (4.4) и т.п.) [из 2.5 ГОСТ 19.505-79]
Поскольку программа не консольная (с интерфейсом командной строки), а с графическим пользовательским интерфейсом, классических текстовых сообщений не предвидится. Сообщения об ошибках отображаются в виде окон на рабочем столе.
«описание их содержания»
Ошибка сохранения файла
При попытке сохранения файла с именем уже существующего файла на рабочем столе программы будет отображено сообщение об ошибке.
«и соответствующие действия оператора»
Для сохранения файла с именем, отличным от имени существующего файла, следует:
Об иллюстрациях
Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками [из 2.6 ГОСТ 19.505-79]
В настоящем учебно-тренировочном руководстве оператора в качестве иллюстраций используются экранные формы (окна), отображаемые на рабочем столе.
О приложениях
В приложения (5) к руководству оператора допускается включать различные материалы, которые нецелесообразно включать в разделы руководства [из 2.7 ГОСТ 19.505-79]
Все, что душе угодно.
Выводы
Причиной для таких утверждений, судя по всему, стали:
Отдельно о буржуйских стандартах. Через некоторое время планируется опубликовать сравнительный анализ ГОСТ 19-й системы и IEEE Std 830-1998, а также IEEE Std 1063-2001 с целью показать:
Copyright © «Техническая документация» 2008-2021. Заимствуйте наши материалы с блеском! При воспроизведении материалов портала обязательна установка активной гиперссылки на источник — страницу с этой публикацией на tdocs.su.
Что такое руководство оператора
Единая система программной документации
Требования к содержанию и оформлению
Unified system for program documentation. Operation’s guide. Requirements for contents and form of presentation
Дата введения 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.
Стандарт полностью соответствует СТ СЭВ 2096-80.
| Обозначение: | ГОСТ 19.505-79* |
| Название рус.: | Единая система программной документации. Руководство оператора. Требования к содержанию и оформлению |
| Статус: | действующий |
| Дата актуализации текста: | 01.10.2008 |
| Дата добавления в базу: | 01.02.2009 |
| Дата введения в действие: | 01.01.1980 |
| Утвержден: | Госстандарт СССР (12.01.1979) |
| Опубликован: | Издательство стандартов № 1987 ИПК Издательство стандартов № 2001 |
Единая система программной документации
Требования к содержанию и оформлению
Unified system for program documentation. Operation’s guide. Requirements for contents and form of presentation
Постановлением Государственного комитета СССР по стандартам от 12января 1979 г. № 74 дата введения установлена
Издание с Изменением № 1, утвержденным в сентябре 1981 г.(ИУС 11-81).
Стандарт полностью соответствует СТ СЭВ 2096-80.
(Измененная редакция, Изм. № 1).
1. ОБЩИЕ ПОЛОЖЕНИЯ
Составление информационной части (аннотации и содержания)является обязательным.
1.2. Руководство оператора должно содержать следующиеразделы:
условия выполнения программы;
В зависимости от особенностей документа допускаетсяобъединять отдельные разделы или вводить новые.
(Измененная редакция, Изм. № 1).
2. СОДЕРЖАНИЕ РАЗДЕЛОВ
2.1. В разделе «Назначение программы» должны бытьуказаны сведения о назначении программы и информация, достаточная для пониманияфункций программы и ее эксплуатации.
2.2. В разделе «Условия выполнения программы»должны быть указаны условия, необходимые для выполнения программы (минимальныйи (или) максимальный состав аппаратурных и программных средств и т. п.).
2.3. В разделе «Выполнение программы» должны быть:указана последовательность действий оператора, обеспечивающих загрузку, запуск,выполнение и завершение программы, приведены описание функций, формата ивозможных вариантов команд, с помощью которых оператор осуществляет загрузку иуправляет выполнением программы, а также ответы программы на эти команды.
2.2, 2.3. (Измененная редакция, Изм. № 1).
2.4. (Исключен, Изм. № 1).
2.5. В разделе «Сообщения оператору» должны бытьприведены тексты сообщений, выдаваемых в ходе выполнения программы, описание ихсодержания и соответствующие действия оператора (действия оператора в случаесбоя, возможности повторного запуска программы и т. п.).
2.6. Допускается содержание разделов иллюстрироватьпоясняющими примерами, таблицами, схемами, графиками.
(Измененная редакция, Изм. № 1).
2.7. В приложения к руководству оператора допускаетсявключать различные материалы, которые нецелесообразно включать в разделыруководства.
ГОСТ 19.505-79 Руководство оператора. Требования к содержанию и оформлению
ГОСТ 19.505-79 Руководство оператора. Требования к содержанию и оформлению