Как писать руководство оператора

В 2004 — 2005 годах был опубликован минимально необходимый набор «учебно-тренировочных» документов на программы, включающий техническое задание на программу по ГОСТ 19.201-78, программу и методику испытаний по ГОСТ 19.301-79, руководство оператора по ГОСТ 19.505-79. Этого достаточно для разработки программы, проведения испытаний и сдачи ее заказчику. Редакция от 23.01.2022.

Создан 16.02.2010 19:41:18

Структура разделов руководства оператора по ГОСТ 19.505-79 приведена на рисунке.

Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.

Составление информационной части (аннотации и содержания) является обязательным [из 1.1 ГОСТ 19.505-79]

В аннотации целесообразно привести следующую фразу: «Настоящее руководство распространяется исключительно на программу и не заменяет учебную, справочную литературу, руководства от производителя ОС и прочие источники информации, освещающие работу с графическим пользовательским интерфейсом операционной системы». Допустимо создание подраздела «Назначение руководства» или «Рекомендации по освоению».

Состав руководства

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

• назначение программы (1);
• условия выполнения программы (2);
• выполнение программы (3);
• сообщения оператору (4).

В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые [из 1.2 ГОСТ 19.505-79]

Последняя фраза предоставляет разработчикам программной документации пространство для маневра.

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

В разделе «Назначение программы» должны быть указаны сведения о назначении программы (1.1) и информация, достаточная для понимания функций программы и ее эксплуатации (1.2) [из 2.1 ГОСТ 19.505-79]

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

Функциональное назначение

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

Эксплуатационное назначение

Программа должна эксплуатироваться в профильных подразделениях на объектах заказчика.

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

Состав функций

Программа обеспечивает возможность выполнения перечисленных ниже функций:

1. Функции создания нового (пустого) файла;
2. Функции открытия (загрузки) существующего файла;
3. Функции редактирования открытого (далее — текущего) файла путем ввода, замены, удаления содержимого файла с применением стандартных устройств ввода;
4. Функции редактирования текущего файла с применением буфера обмена операционной системы;
5. Функции сохранения файла с исходным именем;
6. Функции сохранения файла с именем, отличным от исходного;
7. Функции отправки содержимого текущего файла электронной почтой с помощью внешней клиентской почтовой программы;
8. Функции вывода оперативных справок в строковом формате (подсказок);
9. Функции интерактивной справочной системы;
10. Функции отображения названия программы, версии программы, копирайта и комментариев разработчика.

Условия выполнения программы

В разделе «Условия выполнения программы» должны быть указаны условия, необходимые для выполнения программы (2.1) (минимальный и (или) максимальный состав аппаратурных (2.2) и программных средств (2.3) и т.п.) [из 2.2 ГОСТ 19.505-79]

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

Климатические условия эксплуатации

Климатические условия эксплутатации, при которых должны обеспечиваться заданные характеристики, должны удовлетворять требованиям, предъявляемым к техническим средствам в части условий их эксплуатации.

Минимальный состав технических средств

В состав технических средств должен входить IBM-совместимый персональный компьютер (ПЭВМ), включающий в себя:

1. процессор Pentium-1000 с тактовой частотой, ГГц — 10, не менее;
2. материнскую плату с FSB, ГГц — 5, не менее;
3. оперативную память объемом, Тб — 10, не менее;
4. и так далее…

Минимальный состав программных средств

Системные программные средства, используемые программой, должны быть представлены лицензионной локализованной версией операционной системы. Допускается использование пакета обновления такого-то.

Требования к персоналу (пользователю)

Минимальное количество персонала, требуемого для работы программы, должно составлять не менее 2 штатных единиц – системный администратор и пользователь программы – оператор.

Системный администратор должен иметь высшее профильное образование и сертификаты компании-производителя операционной системы. В перечень задач, выполняемых системным администратором, должны входить:

1. задача поддержания работоспособности технических средств;
2. задачи установки (инсталляции) и поддержания работоспособности системных программных средств – операционной системы;
3. задача установки (инсталляции) программы.

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

Персонал должен быть аттестован на II квалификационную группу по электробезопасности (для работы с конторским оборудованием).

Выполнение программы

В разделе «Выполнение программы» должна быть указана последовательность действий оператора, обеспечивающих загрузку (3.1), запуск (3.2), выполнение (3.3) и завершение программы (3.6), приведено описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузки и управляет выполнением программы (3.4), а также ответы программы на эти команды (3.5) [из 2.3 ГОСТ 19.505-79]

Автоматически, «пальцами», создаем подразделы:

• Загрузка и запуск программы;
• Выполнение программы;
• Завершение работы программы.

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

Загрузка и запуск программы

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

В случае успешного запуска программы на рабочем столе будет отображено Главное окно программы.

Выполнение программы

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

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

Выполнение функции создания нового (безымянного) файла

Выполнение указанной функции возможно любым из перечисленных ниже способов:

1. последовательным выбором пунктов меню Файл-Создать;
2. нажатием кнопки .

В случае успешного выполнения указанной функции на рабочем столе будет отображено окно (см. Загрузка и запуск программы). Программа готова к вводу и редактированию текста.

Примечание — При успешном завершении загрузки и запуска программа автоматически создаст новый (безымянный) файл.

Подход прост. Действие — результат, см. Схема «действие — результат» в совокупности с подходом «делай, как я сказал». Ошибочный результат – сообщение об ошибке.

Сторонники «дружественного» отношения к пользователю вправе озаглавить подраздел, к примеру, так — «Создание нового файла». Ни буква, ни дух ГОСТ 19.505-79 этому не препятствуют. В настоящем документе исключено прямое обращение к пользователю. Отсутствуют «откройте», «нажмите», «укажите» и пр. Применены штампы «следует открыть», «следует нажать» и им подобные (согласно ГОСТ 2.105-95).

Выполнение функции открытия (загрузки) существующего файла

Выполнение указанной функции возможно любым из перечисленных ниже способов:

1. последовательным выбором пунктов меню Файл-Открыть;
2. нажатием кнопки ;
3. последовательным нажатием клавиш Ctrl и O (сочетанием клавиш Ctrl+O).

В результате на рабочем столе будет отображено окно Открыть.

Примечание — Программа обеспечивает возможность загрузки файлов только с расширением *.rtf.

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

В случае успешного (выполнения программой функции) открытия файла на рабочем столе будет отображено окно с содержимым открытого (текущего) файла. Заголовок Главного окна программы будет отображать полный путь текущего файла.

Неразумно брать на себя ответственность уважаемого г-на Торвальдса и компании, тем более — г-на Гейтса. Не должно настоящее руководство заменять учебную, справочную литературу, руководства от производителей ОС и прочие источники информации, освещающие работу с графическим пользовательским интерфейсом операционной системы. Понадобится пользователю открыть файл средствами операционной системы — пусть изучает матчасть и расширяет, тем самым, свой кругозор.

Выполнение функции редактирования текущего файла путем ввода, замены, удаления содержимого файла с применением устройств ввода

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

Редактирование текущего файла путем ввода текста с устройств ввода

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

• пометку в тексте стартовой позиции редактирования;
• ввод (набор) текста.

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

Далее следует вводить (набирать) требуемый текст с клавиатуры. По мере ввода символов изображение курсора будет смещаться вправо.

Редактирование текущего файла путем замены содержимого с применением устройств ввода

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

• выделение текста, подлежащего замене;
• ввод (набор) текста.

Для выделения текста, подлежащего замене, следует:

• переместить курсор в стартовую позицию фрагмента;
• нажать левую клавишу мыши и, не отпуская ее, переместить курсор в конечную позицию фрагмента.

Фрагмент текста будет выделен цветом.

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

Редактирование текущего файла путем удаления содержимого с применением устройств ввода

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

• выделение текста, подлежащего удалению;
• удаление.

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

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

1. нажатием клавиши Delete;
2. нажатием сочетания клавиш Ctrl+X;
3. нажатием клавиши BackSpace.

Выполнение функции редактирования текущего файла с применением буфера обмена операционной системы

Указанная функция включает в себя перечисленные ниже операции:

• операцию копирования (фрагмента) файла;
• операцию вставки содержимого буфера обмена в файл.

Выполнение операции копирования (фрагмента) файла

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

• выделение текста, подлежащего копированию;
• копирование.

Детальные сведения о способах выделения текстового фрагмента изложены во втором абзаце п. Редактирование текущего файла путем замены содержимого с применением устройств ввода. По завершении выделения фрагмента кнопка копирования примет вид .

Примечание — При отсутствии выделенного (фрагмента) текста выполнение операции копирования невозможно. Кнопка копирования недоступна и имеет вид , пункт меню Копировать недоступен.

Выполнение указанной операции возможно любым из перечисленных ниже способов:

1. последовательным выбором пунктов меню Правка-Копировать;
2. нажатием кнопки ;
3. нажатием сочетания клавиш Ctrl+C.

В результате выполнения указанной операции выделенный фрагмент текста текущего файла будет помещен в буфер обмена операционной системы.

Выполнение операции вставки содержимого буфера обмена в файл

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

• пометку (указание) в тексте текущего файла стартовой позиции вставки;
• вставку содержимого буфера обмена.

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

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

Выполнение указанной операции возможно любым из перечисленных ниже способов:

1. последовательным выбором пунктов меню Правка-Вставить;
2. нажатием кнопки ;
3. нажатием сочетания клавиш Ctrl+V.

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

Выполнение функции сохранения файла с исходным именем

Выполнение указанной функции возможно любым из перечисленных ниже способов:

1. последовательным выбором пунктов меню Файл-Сохранить;
2. нажатием кнопки ;
3. последовательным нажатием клавиш Ctrl и S (сочетанием клавиш Ctrl+S).

Выполнение функции сохранения файла с именем, отличным от исходного

…

Наверное, достаточно. Нет смысла дублировать (фактически) описания выполнения типовых функций программы в учебно-тренировочном документе.

Завершение работы программы

Завершение работы программы обеспечиваются стандартными средствами операционной системы.

или

Выполнение указанной функции возможно любым из перечисленных ниже способов:

1. последовательным выбором пунктов меню Файл-Выход (см. рисунок такой-то);
2. нажатием кнопки .

Сообщения оператору

В разделе «Сообщения оператору» должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы (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-я система стандартов безнадежно устарела и не может быть применена для разработки современных программ с графическим пользовательским интерфейсом, а также для разработки и выпуска качественной программной документации к программным изделиям — чушь.

Причиной для таких утверждений, судя по всему, стали:

• обычная лень — нежелание открыть ЕСПД и один-единственный раз (!) во всем разобраться;
• тяга к оформительству, подогреваемая отдельными маститыми «техническими писателями»;
• тяга к буржуйским стандартам (ибо нет пророка в своем отечестве);
• и еще много чего.

Отдельно о буржуйских стандартах. Через некоторое время планируется опубликовать сравнительный анализ ГОСТ 19-й системы и IEEE Std 830-1998, а также IEEE Std 1063-2001 с целью показать:

• превосходство советских стандартов 25-летней давности в целом;
• «цельнотянутость» буржуйских с наших.

Примечание от 17.02.2010 г. — Сравнительный анализ указанных документов дан в статье «Как писать руководство пользователя? Часть I».

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

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

Примерный
план написания руководства пользователя
в соответствии с ГОСТ 19.505-79 «Руководство
оператора» /2/:

1.
Действия при запуске программы (какой
файл должен быть запущен, какие действия
должны при этом выполняться).

2.
Структура программы (какие окна есть,
как между ними переключаться, структура
меню и назначение его элементов).

3.
Каким образом осуществляется ввод
данных.

4.
Какая информация выводится на экран.

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

При
необходимости можно указать: требуются
ли от пользователя какие-либо настройки,
если да, то какие; нужно ли использовать
дополнительное программное обеспечение
и т.п.

5. Оформление пояснительной записки

Оформление
пояснительной записки к курсовой работе
выполняется в соответствии правилами,
принятыми кафедрой «Программное
обеспечение» /3/.

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

При
описании литературного источника
необходимо указать /4,5/:

• фамилии
  и инициалы авторов,

• название
  книги или статьи,

• место
  издания,

• издательство,

• год
  издания.

При
описании ссылки на сайт Интернета
указать:

• адрес
  сайта,

• наименование
  сайта.

В
приложениях
помещают вспомогательные или дополнительные
материалы, которые иллюстрируют текст
основной части работы ( таблицы, графики,
диаграммы, схемы, рисунки). В приложение
выносятся тексты программ и руководство
пользователя. Каждое приложение должно
начинаться с новой страницы с указанием
в правом верхнем углу слова «ПРИЛОЖЕНИЕ»
и иметь тематический заголовок. При
наличии в работе более одного приложения
они нумеруются арабскими цифрами. На
все представленные приложения должны
быть сделаны ссылки из текста.

6. Защита курсовой работы

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

По
результатам защиты курсовых работ
выставляется зачет с дифференцированной
оценкой по четырехбальной системе
(«отлично», «хорошо», «удовлетворительно»,
«неудовлетворительно»)

В
ходе защиты курсовой работы оцениваются:

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

• знание
  среды программирования и основ
  алгоритмизации, степень владения
  материалом;

• аккуратность
  оформления пояснительной записки;

• соответствие
  материалов работы требованиям ГОСТ и
  правилам, установленным кафедрой;

• понимание
  использованных математических методов;

• изложение
  материалов в устном докладе.

Соседние файлы в предмете [НЕСОРТИРОВАННОЕ]

• #
• #
• #
• #
• #
• #
• #
• #
• #
• #
• #

Руководство оператора – это основной документ в составе эксплуатационной документации на программное обеспечение (ГОСТ 19). Очевидно ли это?

Назначение руководства оператора

В соответствии с государственными стандартами, Руководство оператора входит в состав комплекта эксплуатационной документации на программное обеспечение. Для чего нужен такой документ? Чтобы ответить на этот вопрос, необходимо понять, какую роль в использовании системы играет оператор.

Мы знаем, что администратор отвечает за настройку системы и поддержку работы пользователей. Пользователь же, в свою очередь, выполняет с помощью системы определенные прикладные функции, решает прикладные задачи. Роль оператора по своим функциям ближе всего к роли пользователя, однако, отличается от нее тем, что перед оператором не ставятся прикладные задачи, которые он может решить с помощью программы тем или иным способом, в том или ином порядке. Его работа заключается в выполнении отдельных операций (согласно инструкции), то есть конкретных последовательностей действий, приводящих к конкретному результату (например, ежедневный запуск вспомогательных программ).

Состав типового руководства оператора

Так, например, требования к содержанию и оформлению Руководства оператора представлены в ГОСТ 19.505. В соответствии с требованиями стандарта, документ должен содержать следующие разделы:

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

– Условия выполнения программы, где должны быть указаны условия, необходимые для работы ПО.

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

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

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

– не стоит включать в документ теоретические описания и отступления, лучше собрать всю теорию в отдельный раздел, а лучше, по возможности, обойтись без нее совсем;

– лучше не ссылаться в документе на какие-либо внешние или внутренние источники, информацию предпочтительнее продублировать в том месте, где она необходима;

– описывать нужно не только действия оператора, но и те результаты, которые он должен получить.

Стандарты для руководства оператора

Наличие Руководства оператора регламентируется ГОСТ 19.101, а структура и содержание – ГОСТ 19.505. Однако, в зависимости от сложности, назначения и области применения ПО, различные Руководства оператора могут отличаться друг от друга по способу, методике и стилю изложения.

Заключение

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

---

– разработка руководства администратора;
– создание руководства программиста;
– разработка руководства пользователя.

---

---

ГОСТ 19.505-79 по написанию руководства оператора был принят 12 января 1979 года Государственным комитетом стандартов Совета Министров СССР . В данной документации изложены требования к текстовому наполнению и формам подачи Руководства.

Главные условия

1.      Построение и форма написания документов выполняются согласно ГОСТ 19.105-78. В данном пункте краткое представления содержание обязательно.

2.      Основные разделы Руководства оператора:

— Цель программного продукта. В разделе нужно указать сведения о цели программы, объяснить ее функции и применение.

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

— Исполнение программы. Требуется описать очередность шагов оператора, которые он должен произвести для загрузки, пуска, выполнения и окончания программы. Представить  функции, вероятные команды, какие потребуются оператору для управление программой. Также должны быть прописаны ответы программы на все действия оператора.

— Информация для оператора. В разделе должны содержаться все тексты сообщений, которые выдаются во время работы программы и те действия, которые должен предпринять оператор в соответствии с этими сообщениями.

При необходимости данный раздел может быть дополнен картинками, диаграммами, графиками, схемами, таблицами и примерами.

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