В 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.
Эксплуатационное назначение
Программа должна эксплуатироваться в профильных подразделениях на объектах заказчика.
Пользователями программы должны являться сотрудники профильных подразделений объектов заказчика.
Состав функций
Программа обеспечивает возможность выполнения перечисленных ниже функций:
- Функции создания нового (пустого) файла;
- Функции открытия (загрузки) существующего файла;
- Функции редактирования открытого (далее — текущего) файла путем ввода, замены, удаления содержимого файла с применением стандартных устройств ввода;
- Функции редактирования текущего файла с применением буфера обмена операционной системы;
- Функции сохранения файла с исходным именем;
- Функции сохранения файла с именем, отличным от исходного;
- Функции отправки содержимого текущего файла электронной почтой с помощью внешней клиентской почтовой программы;
- Функции вывода оперативных справок в строковом формате (подсказок);
- Функции интерактивной справочной системы;
- Функции отображения названия программы, версии программы, копирайта и комментариев разработчика.
Условия выполнения программы
В разделе «Условия выполнения программы» должны быть указаны условия, необходимые для выполнения программы (2.1) (минимальный и (или) максимальный состав аппаратурных (2.2) и программных средств (2.3) и т.п.) [из 2.2 ГОСТ 19.505-79]
Создаем соответствующие подразделы. Поскольку «аппаратурных» звучит старообразно, меняем его на «технических».
Климатические условия эксплуатации
Климатические условия эксплутатации, при которых должны обеспечиваться заданные характеристики, должны удовлетворять требованиям, предъявляемым к техническим средствам в части условий их эксплуатации.
Минимальный состав технических средств
В состав технических средств должен входить IBM-совместимый персональный компьютер (ПЭВМ), включающий в себя:
- процессор Pentium-1000 с тактовой частотой, ГГц — 10, не менее;
- материнскую плату с FSB, ГГц — 5, не менее;
- оперативную память объемом, Тб — 10, не менее;
- и так далее…
Минимальный состав программных средств
Системные программные средства, используемые программой, должны быть представлены лицензионной локализованной версией операционной системы. Допускается использование пакета обновления такого-то.
Требования к персоналу (пользователю)
Минимальное количество персонала, требуемого для работы программы, должно составлять не менее 2 штатных единиц – системный администратор и пользователь программы – оператор.
Системный администратор должен иметь высшее профильное образование и сертификаты компании-производителя операционной системы. В перечень задач, выполняемых системным администратором, должны входить:
- задача поддержания работоспособности технических средств;
- задачи установки (инсталляции) и поддержания работоспособности системных программных средств – операционной системы;
- задача установки (инсталляции) программы.
Пользователь программы (оператор) должен обладать практическими навыками работы с графическим пользовательским интерфейсом операционной системы.
Персонал должен быть аттестован на II квалификационную группу по электробезопасности (для работы с конторским оборудованием).
Выполнение программы
В разделе «Выполнение программы» должна быть указана последовательность действий оператора, обеспечивающих загрузку (3.1), запуск (3.2), выполнение (3.3) и завершение программы (3.6), приведено описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузки и управляет выполнением программы (3.4), а также ответы программы на эти команды (3.5) [из 2.3 ГОСТ 19.505-79]
Автоматически, «пальцами», создаем подразделы:
- Загрузка и запуск программы;
- Выполнение программы;
- Завершение работы программы.
Во время оно загрузка программы осуществлялась отдельно, запуск — отдельно. В нынешних условиях загрузка и запуск объединились в единую операцию. Ключевая фраза подраздела «Требования к количеству и квалификации персонала» технического задания — «пользователь программы (оператор) должен обладать практическими навыками работы с графическим пользовательским интерфейсом операционной системы» снимает с автора обязанность подробно расписывать способы загрузки и запуска программы… Не обязан разработчик разжевывать оператору приемы работы с графическим пользовательским интерфейсом операционной системы. За исключением случаев применения в программе элементов интерфейса, не свойственных операционной системе.
Загрузка и запуск программы
Загрузка и запуск программы осуществляется способами, детальные сведения о которых изложены в руководстве пользователя операционной системы.
В случае успешного запуска программы на рабочем столе будет отображено Главное окно программы.
Выполнение программы
«В подразделе следует привести «описание функций, формата и возможных вариантов команд, с помощью которых оператор … управляет выполнением программы».
Выше был приведен перечень функций, возможность выполнения которых обеспечивает программа. Для каждой функции из перечня следует создать подраздел.
Выполнение функции создания нового (безымянного) файла
Выполнение указанной функции возможно любым из перечисленных ниже способов:
- последовательным выбором пунктов меню Файл-Создать;
- нажатием кнопки
.
.В случае успешного выполнения указанной функции на рабочем столе будет отображено окно (см. Загрузка и запуск программы). Программа готова к вводу и редактированию текста.
Примечание — При успешном завершении загрузки и запуска программа автоматически создаст новый (безымянный) файл.
Подход прост. Действие — результат, см. Схема «действие — результат» в совокупности с подходом «делай, как я сказал». Ошибочный результат – сообщение об ошибке.
Сторонники «дружественного» отношения к пользователю вправе озаглавить подраздел, к примеру, так — «Создание нового файла». Ни буква, ни дух ГОСТ 19.505-79 этому не препятствуют. В настоящем документе исключено прямое обращение к пользователю. Отсутствуют «откройте», «нажмите», «укажите» и пр. Применены штампы «следует открыть», «следует нажать» и им подобные (согласно ГОСТ 2.105-95).
Выполнение функции открытия (загрузки) существующего файла
Выполнение указанной функции возможно любым из перечисленных ниже способов:
- последовательным выбором пунктов меню Файл-Открыть;
- нажатием кнопки ;
- последовательным нажатием клавиш Ctrl и O (сочетанием клавиш Ctrl+O).
;В результате на рабочем столе будет отображено окно Открыть.
Примечание — Программа обеспечивает возможность загрузки файлов только с расширением *.rtf.
Выбор требуемого файла осуществляется способами, детальные сведения о которых изложены в руководстве пользователя операционной системы. Завершается выполнение функции нажатием кнопки Открыть.
В случае успешного (выполнения программой функции) открытия файла на рабочем столе будет отображено окно с содержимым открытого (текущего) файла. Заголовок Главного окна программы будет отображать полный путь текущего файла.
Неразумно брать на себя ответственность уважаемого г-на Торвальдса и компании, тем более — г-на Гейтса. Не должно настоящее руководство заменять учебную, справочную литературу, руководства от производителей ОС и прочие источники информации, освещающие работу с графическим пользовательским интерфейсом операционной системы. Понадобится пользователю открыть файл средствами операционной системы — пусть изучает матчасть и расширяет, тем самым, свой кругозор.
Выполнение функции редактирования текущего файла путем ввода, замены, удаления содержимого файла с применением устройств ввода
Предполагается, что операции нетривиальны, специфичны для предметной области и никаких сведений об их выполнении в руководстве пользователя операционной системы нет и быть не может принципиально. Поэтому простые и привычные операции будут расписаны детально.
Редактирование текущего файла путем ввода текста с устройств ввода
Последовательность действий, требуемая для выполнения указанной операции, включает в себя:
- пометку в тексте стартовой позиции редактирования;
- ввод (набор) текста.
Для пометки стартовой позиции редактирования следует переместить курсор в требуемую позицию текста и нажать левую клавишу мыши. В требуемой позиции будет отображен курсор.
Далее следует вводить (набирать) требуемый текст с клавиатуры. По мере ввода символов изображение курсора будет смещаться вправо.
Редактирование текущего файла путем замены содержимого с применением устройств ввода
Последовательность действий, требуемая для выполнения указанной операции, включает в себя:
- выделение текста, подлежащего замене;
- ввод (набор) текста.
Для выделения текста, подлежащего замене, следует:
- переместить курсор в стартовую позицию фрагмента;
- нажать левую клавишу мыши и, не отпуская ее, переместить курсор в конечную позицию фрагмента.
Фрагмент текста будет выделен цветом.
Далее следует вводить требуемый текст с клавиатуры. Выделенный фрагмент текста будет удален. По мере ввода символов изображение курсора будет смещаться вправо.
Редактирование текущего файла путем удаления содержимого с применением устройств ввода
Последовательность действий, требуемая для выполнения указанной операции, включает в себя:
- выделение текста, подлежащего удалению;
- удаление.
Детальные сведения о способах выделения текстового фрагмента изложены во втором абзаце п. Редактирование текущего файла путем замены содержимого с применением устройств ввода.
Удаление может быть выполнено любым из перечисленных ниже способов:
- нажатием клавиши Delete;
- нажатием сочетания клавиш Ctrl+X;
- нажатием клавиши BackSpace.
Выполнение функции редактирования текущего файла с применением буфера обмена операционной системы
Указанная функция включает в себя перечисленные ниже операции:
- операцию копирования (фрагмента) файла;
- операцию вставки содержимого буфера обмена в файл.
Выполнение операции копирования (фрагмента) файла
Последовательность действий, требуемая для выполнения указанной операции, включает в себя:
- выделение текста, подлежащего копированию;
- копирование.
Детальные сведения о способах выделения текстового фрагмента изложены во втором абзаце п. Редактирование текущего файла путем замены содержимого с применением устройств ввода. По завершении выделения фрагмента кнопка копирования примет вид 
.
Примечание — При отсутствии выделенного (фрагмента) текста выполнение операции копирования невозможно. Кнопка копирования недоступна и имеет вид 
, пункт меню Копировать недоступен.
Выполнение указанной операции возможно любым из перечисленных ниже способов:
- последовательным выбором пунктов меню Правка-Копировать;
- нажатием кнопки ;
- нажатием сочетания клавиш Ctrl+C.
В результате выполнения указанной операции выделенный фрагмент текста текущего файла будет помещен в буфер обмена операционной системы.
Выполнение операции вставки содержимого буфера обмена в файл
Последовательность действий, требуемая для выполнения указанной операции, включает в себя:
- пометку (указание) в тексте текущего файла стартовой позиции вставки;
- вставку содержимого буфера обмена.
Примечание — При отсутствии содержимого в буфере обмена выполнение операции вставки невозможно. Кнопка вставки недоступна и имеет вид 
, пункт меню Вставить недоступен.
Для пометки стартовой позиции вставки следует переместить курсор в требуемую позицию текста и нажать левую клавишу мыши. В требуемой позиции будет отображен курсор.
Выполнение указанной операции возможно любым из перечисленных ниже способов:
- последовательным выбором пунктов меню Правка-Вставить;
- нажатием кнопки ;
- нажатием сочетания клавиш Ctrl+V.
;В результате выполнения указанной операции фрагмент текста, содержащегося в буфере обмена, будет помещен в требуемую позицию текущего файла.
Выполнение функции сохранения файла с исходным именем
Выполнение указанной функции возможно любым из перечисленных ниже способов:
- последовательным выбором пунктов меню Файл-Сохранить;
- нажатием кнопки ;
- последовательным нажатием клавиш Ctrl и S (сочетанием клавиш Ctrl+S).
;Выполнение функции сохранения файла с именем, отличным от исходного
…
Наверное, достаточно. Нет смысла дублировать (фактически) описания выполнения типовых функций программы в учебно-тренировочном документе.
Завершение работы программы
Завершение работы программы обеспечиваются стандартными средствами операционной системы.
или
Выполнение указанной функции возможно любым из перечисленных ниже способов:
- последовательным выбором пунктов меню Файл-Выход (см. рисунок такой-то);
- нажатием кнопки
.
.Сообщения оператору
В разделе «Сообщения оператору» должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы (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). Очевидно ли это?
Назначение руководства оператора
В соответствии с государственными стандартами, Руководство оператора входит в состав комплекта эксплуатационной документации на программное обеспечение. Для чего нужен такой документ? Чтобы ответить на этот вопрос, необходимо понять, какую роль в использовании системы играет оператор.
Мы знаем, что администратор отвечает за настройку системы и поддержку работы пользователей. Пользователь же, в свою очередь, выполняет с помощью системы определенные прикладные функции, решает прикладные задачи. Роль оператора по своим функциям ближе всего к роли пользователя, однако, отличается от нее тем, что перед оператором не ставятся прикладные задачи, которые он может решить с помощью программы тем или иным способом, в том или ином порядке. Его работа заключается в выполнении отдельных операций (согласно инструкции), то есть конкретных последовательностей действий, приводящих к конкретному результату (например, ежедневный запуск вспомогательных программ).
Состав типового руководства оператора
Так, например, требования к содержанию и оформлению Руководства оператора представлены в ГОСТ 19.505. В соответствии с требованиями стандарта, документ должен содержать следующие разделы:
– Назначение программы, где указывают область применения ПО и общие сведения о ней.
– Условия выполнения программы, где должны быть указаны условия, необходимые для работы ПО.
– Выполнение программы, где описывают последовательность действий оператора, обеспечивающих выполнение его обязанностей, а также ожидаемые реакции программы на эти действия.
– Сообщения оператору, где приводят тексты сообщений, выдаваемых в ходе выполнения программы, а также действия оператора в случае, если реакция программы не соответствует ожидаемой.
Такая структура документа обычно позволяет сделать его удобным, понятным и отвечающим тем задачам, которые необходимо решить с его помощью. Однако, кроме официальных требований, на основании практического опыта можно сформулировать несколько принципов создания Руководства оператора:
– не стоит включать в документ теоретические описания и отступления, лучше собрать всю теорию в отдельный раздел, а лучше, по возможности, обойтись без нее совсем;
– лучше не ссылаться в документе на какие-либо внешние или внутренние источники, информацию предпочтительнее продублировать в том месте, где она необходима;
– описывать нужно не только действия оператора, но и те результаты, которые он должен получить.
Стандарты для руководства оператора
Наличие Руководства оператора регламентируется ГОСТ 19.101, а структура и содержание – ГОСТ 19.505. Однако, в зависимости от сложности, назначения и области применения ПО, различные Руководства оператора могут отличаться друг от друга по способу, методике и стилю изложения.
Стоимость разработки руководства оператора
|
Наименование документа |
Наименование стандарта |
Стоимость разработки |
|---|---|---|
|
Руководство оператора на программное обеспечение |
ГОСТ 19.505 |
от 70 тыс. р. |
В заключение хочется сказать, что, несмотря на все принципы и правила, у каждой системы всегда существуют особенности эксплуатации, которые нужно учесть в документации. Обратитесь к нам, и мы поможем вам преодолеть эти трудности и сэкономим ваше время!
Возможно, вас также заинтересует:
– разработка руководства администратора;
– создание руководства программиста;
– разработка руководства пользователя.
Разработка
руководства по работе с программой
является одним из этапов создания
программного обеспечения. Оно должно
содержать подробные инструкции по
работе с программой, а также экранные
формы, иллюстрирующие текст.
Руководство
пользователя должно быть организовано
таким образом, чтобы любому человеку,
не знакомому со средой программирования,
программой и реализуемым ею методом,
были понятны действия, которые от него
требуется выполнить.
Примерный
план написания руководства пользователя
в соответствии с ГОСТ 19.505-79 «Руководство
оператора» /2/:
1.
Действия при запуске программы (какой
файл должен быть запущен, какие действия
должны при этом выполняться).
2.
Структура программы (какие окна есть,
как между ними переключаться, структура
меню и назначение его элементов).
3.
Каким образом осуществляется ввод
данных.
4.
Какая информация выводится на экран.
Таким
образом, нужно рассмотреть последовательность
всех операций по работе с программой
на конкретном примере, делая подробные
комментарии и иллюстрируя текст
графически.
При
необходимости можно указать: требуются
ли от пользователя какие-либо настройки,
если да, то какие; нужно ли использовать
дополнительное программное обеспечение
и т.п.
5. Оформление пояснительной записки
Оформление
пояснительной записки к курсовой работе
выполняется в соответствии правилами,
принятыми кафедрой «Программное
обеспечение» /3/.
В
список использованных источников
включаются только те источники, которые
использовались при подготовке курсовой
работы и на которые имеются ссылки в
работе.
При
описании литературного источника
необходимо указать /4,5/:
-
фамилии
и инициалы авторов, -
название
книги или статьи, -
место
издания, -
издательство,
-
год
издания.
При
описании ссылки на сайт Интернета
указать:
-
адрес
сайта, -
наименование
сайта.
В
приложениях
помещают вспомогательные или дополнительные
материалы, которые иллюстрируют текст
основной части работы ( таблицы, графики,
диаграммы, схемы, рисунки). В приложение
выносятся тексты программ и руководство
пользователя. Каждое приложение должно
начинаться с новой страницы с указанием
в правом верхнем углу слова «ПРИЛОЖЕНИЕ»
и иметь тематический заголовок. При
наличии в работе более одного приложения
они нумеруются арабскими цифрами. На
все представленные приложения должны
быть сделаны ссылки из текста.
6. Защита курсовой работы
На
защиту представляется пояснительная
записка с подписями студента и
руководителя, файлы программы.
По
результатам защиты курсовых работ
выставляется зачет с дифференцированной
оценкой по четырехбальной системе
(«отлично», «хорошо», «удовлетворительно»,
«неудовлетворительно»)
В
ходе защиты курсовой работы оцениваются:
-
правильность
и работоспособность программы, полнота
ее функциональных возможностей,
интерфейс пользователя; -
знание
среды программирования и основ
алгоритмизации, степень владения
материалом; -
аккуратность
оформления пояснительной записки; -
соответствие
материалов работы требованиям ГОСТ и
правилам, установленным кафедрой; -
понимание
использованных математических методов; -
изложение
материалов в устном докладе.
Соседние файлы в предмете [НЕСОРТИРОВАННОЕ]
- #
- #
- #
- #
- #
- #
- #
- #
- #
- #
- #
Общая информация
Документация принадлежит к типу программной, эксплуатационной документации пользователя. Объединяет в себе пакеты документов программы, программного компонента системы или комплекса. Создается для операторов. Целью документации является обеспечение оператору комфортной работы с программным продуктом. Все документы соответствуют стандартам: ГОСТ 19.505-79.
Предмет и применение
Работа оператора сходна с действиями пользователя. Оператор не настраивает систему, а производит необходимые действия в заданную единицу времени: запускает программу, принимает сведения, формирует отчеты и т.д. В руководстве описаны все действия, чтобы работа оператора была четкой и регламентируемой.
Содержание
Руководство оператора схоже с инструкцией пользователя. В нем указаны все алгоритмы решения возможных задач и проблем.
Методология и язык написания
Язык текста должен быть максимально простым и понятным, инструкции – ясными и понятными.
1. Вся теоретическая информация сведена к минимуму и содержится в одном разделе.
2. Отсутствие ссылок.
3. Конкретные указания.
4. Описание производимых действий и их последствий.
Стандартная структура — согласно ГОСТ 19.505-79.
1. Назначение программы.
2. Условия выполнения программы.
3. Выполнение программы.
4. Сообщения оператору.
Практическая работа №13
Тема: Руководство пользователя.
Цель работы: Ознакомиться с видами руководства
пользователя, изучить нормативно правовую документацию, регламентирующую
разработку руководств пользователя, приобрести навыки разработки руководства
пользователя программного средства.
Теоретические
сведения.
Руководство
пользователя (user guide или user
manual), руководство по эксплуатации, руководство
оператора — документ, назначение которого — предоставить людям помощь
в использовании некоторой системы. Документ входит в состав технической
документации на систему и, как правило,
подготавливается техническим писателем.
Большинство
руководств пользователя помимо текстовых описаний содержит изображения. В
случае программного обеспечения, в
руководство обычно включаются снимки экрана, при
описании аппаратуры — простые и понятные рисунки или фотографии. Используется
стиль и язык, доступный предполагаемой аудитории, использование жаргона сокращается до
минимума либо подробно объясняется.
Содержание
Типичное
руководство пользователя содержит:
·
Аннотацию, в
которой приводится краткое изложение содержимого документа и его назначение
·
Введение,
содержащее
ссылки на связанные документы и информацию о том, как лучше всего использовать
данное руководство
·
Страницу
содержания
·
Главы,
описывающие, как использовать, по крайней мере, наиболее важные функции
системы
·
Главу, описывающую
возможные проблемы и пути их решения
·
Часто
задаваемые вопросы и ответы
на них
·
Где
ещё найти информацию по предмету, контактная информация
·
Глоссарий и, в
больших документах, предметный указатель
Все главы и
пункты, а также рисунки и таблицы, как правило, нумеруются, с тем, чтобы на них
можно было сослаться внутри документа или из другого документа. Нумерация также
облегчает ссылки на части руководства, например, при общении пользователя со
службой поддержки.
Стандарты
Структура и
содержание документа Руководство пользователя автоматизированной
системы регламентированы подразделом 3.4 документа РД 50-34.698-90. Структура и
содержание документов Руководство оператора, Руководство
программиста, Руководство системного программиста регламентированы
ГОСТ 19.505-79, ГОСТ 19.504-79 и ГОСТ 19.503-79 соответственно.
·
Комплекс
стандартов и руководящих документов на автоматизированные системы (ГОСТ 34)
· РД
50-34.698-90 АВТОМАТИЗИРОВАННЫЕ СИСТЕМЫ. ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ
·
Единая система конструкторской документации (ЕСКД)
определяет документ «Руководство по эксплуатации» и другие документы:
· ГОСТ
2.601-2013 Эксплуатационные документы
· ГОСТ
2.610-2006 Правила выполнения эксплуатационных документов
·
Единая
система программной документации (ЕСПД)
определяет документы «Руководство оператора», «Руководство по техническому обслуживанию»
и их структуру:
· ГОСТ
19.101-77 Виды программ и программных документов
· ГОСТ
19.105-78 Общие требования к программным документам
· ГОСТ
19.505-79 Руководство оператора. Требования к содержанию и оформлению
· ГОСТ
19.508-79 Руководство по техническому обслуживанию. Требования к содержанию и
оформлению.
Руководство
пользователя согласно требованиям ГОСТ
Документ
«Руководство пользователя» относится к пакету эксплуатационной документации.
Основная цель руководства пользователя заключается в обеспечении пользователя
необходимой информацией для самостоятельной работы с программой или
автоматизированной системой.
Таким
образом, документ Руководство пользователя должен отвечать на следующие
вопросы: что это за программа, что она может, что необходимо для обеспечения ее
корректного функционирования и что делать в случае отказа системы.
Руководящими
стандартами для создания документа Руководство пользователя могут
являться как РД
50-34.698-90 в п.п. 3.4. «Руководство пользователя», так
и ГОСТ
19.505-79 «Руководство оператора. Требования к содержанию и оформлению». Ниже для
сравнения приведены структуры документа согласно двум перечисленным стандартам.
|
РД |
ГОСТ 19.505-79 Руководство оператора |
|
Введение |
|
|
Область |
|
|
Описание |
|
|
Уровень |
|
|
Перечень |
|
|
Назначение |
|
|
Виды |
Назначение |
|
Условия, |
Условия |
|
Подготовка |
Выполнение |
|
Состав |
|
|
Порядок |
Порядок |
|
Проверка |
|
|
Описание |
Описание |
|
Описание |
|
|
Описание |
|
|
Аварийные |
Сообщения |
|
Рекомендации |
Таким образом, мы можем выделить следующие основные разделы руководства
пользователя:
ü Назначение
системы;
ü Условия применения
системы;
ü Подготовка системы
к работе;
ü Описание операций;
ü Аварийные
ситуации.
Назначение системы
Данный раздел
документа Руководство пользователя должен содержать информацию о назначении
системы, ее целях и задачах.
Пример:
«Корпоративный
интранет портал предназначен для повышения корпоративной культурыр организации
эффективного взаимодействия сотрудников.
Основной
целью Порта является создание единого информационного пространства предприятия
и оптимизация работы сотрудников путем облегчения коммуникаций между ними и
оптимизации ряда бизнес-процессов.»
Условия
применения системы
Данный
раздел документа Руководство пользователя должен включать все те факторы,
которые необходимы для корректной работы системы. Здесь можно выделить
несколько подразделов:
Требования
к аппаратному обеспечению – сюда можно включить требования к конфигурации
компьютера пользователя, программное обеспечение необходимое для работы
Системы, а также наличие дополнительного оборудования (принтер, сканер и т.п.),
если таковое необходимо;
Квалификация
пользователя – данный подраздел должен содержать требования к навыкам и знаниям
пользователя (пример: «Пользователи должны обладать навыками работы с
операционной системой Windows XP»);
Подготовка
системы к работе
Данный
раздел документа Руководство пользователя должен содержать пошаговую инструкцию
для запуска приложения. К этапу подготовки системы к работе можно отнести
установку дополнительных приложений (при необходимости), идентификацию,
аутентификацию и т.п.
Описание
операций
Это
основной раздел документа Руководство пользователя, который содержит пошаговую
инструкцию для выполнения того или иного действия пользователем.
Если
работа автоматизированной системы затрагивает целый бизнес-процесс, то в
руководстве пользователя перед описанием операций целесообразно предоставить
информацию о данном процессе его назначении и участниках. Подобное решение
позволяет человеку четко представить свою роль в данном процессе и те функции,
которые реализованы для него в системе.
Далее в
документе Руководство пользователя следует представить описание функций
разбитых на отдельные операции. Необходимо выделить подразделы, описывающие
функции данного процесса, и действия, которые необходимо совершить для их
выполнения.
Пример:
«4.1
Согласование проекта. Данный процесс предназначен для организации работы
сотрудников, участвующих в разработке и согласовании проекта.
Автор проекта создает запись в Системе и прикрепляет пакет необходимой
документации, далее проект передается на согласование руководящими лицами.
Руководители после ознакомления с проектом могут подтвердить его или отправить
на доработку Автору.
4.1.1
Создание проекта. Для того чтобы создать Проект необходимо на панели «…»
нажать на кнопку «…» и в появившейся форме заполнить следующие поля:
Наименование
проекта;
Описание
проекта;
Следующие
поля заполняются автоматически:
Дата
создания проекта – текущая дата;
Автор –
ИФО и должность автора проекта.»
Руководство
пользователя может представлять собой как краткий справочник по основному
функционалу программы, так и полное учебное пособие. Методика изложения
материала в данном случае будет зависеть от объема самой программы и требований
заказчика.
Чем
подробнее будут описаны действия с системой, тем меньше вопросов возникнет у
пользователя. Для более легкого понимания всех принципов работы с программой
стандартами в документе Руководство пользователя допускается использовать
схемы, таблицы, иллюстрации с изображением экранных форм.
Для
крупных автоматизированных систем рекомендуется создавать отдельное руководство
для каждой категории пользователя (пользователь, модератор и т.п.). Если в
работе с системой выделяются дополнительные роли пользователей, то в документе
Руководство пользователя целесообразно поместить таблицу распределения функций
между ролями.
Аварийные
ситуации
Данный
раздел документа Руководство пользователя должен содержать пошаговые инструкции
действий пользователя в случае отказа работы Системы. Если к пользователю не
были предъявлены особые требования по администрированию операционной системы и
т.п., то можно ограничиться фразой «При отказе или сбое в работе Системы
необходимо обратиться к Системному администратору».
Ниже представлен пример (образец)
документа «Руководство пользователя«, разработанного на
основании методических указаний РД
50-34.698-90.
Данный документ формируется
IT-специалистом, или функциональным специалистом, или техническим писателем в
ходе разработки рабочей документации на систему и её части на стадии «Рабочая
документация».
Для формирования руководства пользователя
в качестве примера был взят инструмент Oracle Discoverer информационно-аналитической
системы «Корпоративное хранилище данных».
Ниже приведен состав руководства
пользователя в соответствии с ГОСТ. Внутри каждого из разделов кратко приведены требования к
содержанию и текст примера заполнения (выделен вертикальной
чертой).
Разделы руководства пользователя:
1.
Введение.
2.
Назначение и
условия применения.
3.
Подготовка к
работе.
4.
Описание операций.
5.
Аварийные
ситуации.
6.
Рекомендации по
освоению.
1. Введение
В разделе «Введение»
указывают:
1.
область применения;
2.
краткое
описание возможностей;
3.
уровень
подготовки пользователя;
4.
перечень
эксплуатационной документации, с которой необходимо ознакомиться пользователю.
1.1. Область применения
Требования настоящего документа
применяются при:
· предварительных комплексных
испытаниях;
· опытной эксплуатации;
· приемочных испытаниях;
· промышленной эксплуатации.
1.2. Краткое описание возможностей
Информационно-аналитическая
система Корпоративное Хранилище Данных (ИАС КХД) предназначена для оптимизации
технологии принятия тактических и стратегических управленческих решений
конечными бизнес-пользователями на основе информации о всех аспектах
финансово-хозяйственной деятельности Компании.
ИАС КХД предоставляет возможность
работы с регламентированной и нерегламентированной отчетностью.
При работе с отчетностью
используется инструмент пользователя Oracle Discoverer Plus, который
предоставляет следующие возможности:
· формирование табличных и
кросс-табличных отчетов;
· построение различных диаграмм;
· экспорт и импорт результатов
анализа;
· печать результатов анализа;
· распространение результатов
анализа.
1.3. Уровень подготовки
пользователя
Пользователь ИАС КХД должен иметь
опыт работы с ОС MS Windows (95/98/NT/2000/XP), навык работы с ПО Internet
Explorer, Oracle Discoverer, а также обладать следующими знаниями:
· знать соответствующую предметную
область;
· знать основы многомерного анализа;
· понимать многомерную модель
соответствующей предметной области;
· знать и иметь навыки работы с
аналитическими приложениями.
Квалификация пользователя должна
позволять:
· формировать отчеты в Oracle
Discoverer Plus;
· осуществлять анализ данных.
1.4. Перечень эксплуатационной
документации, с которой необходимо ознакомиться пользователю
· Информационно-аналитическая
система «Корпоративное хранилище данных». ПАСПОРТ;
· Информационно-аналитическая
система «Корпоративное хранилище данных». ОБЩЕЕ ОПИСАНИЕ СИСТЕМЫ.
2. Назначение и условия применения
Oracle Discoverer Plus
В разделе «Назначение и
условия применения» указывают:
1.
виды
деятельности, функции, для автоматизации которых предназначено данное средство
автоматизации;
2.
условия, при
соблюдении (выполнении, наступлении) которых обеспечивается применение средства
автоматизации в соответствии с назначением (например, вид ЭВМ и конфигурация
технических средств, операционная среда и общесистемные программные средства,
входная информация, носители данных, база данных, требования к подготовке
специалистов и т. п.).
Oracle Discoverer Plus в составе
ИАС КХД предназначен для автоматизации подготовки, настройки отчетных форм по
показателям деятельности, а также для углубленного исследования данных на
основе корпоративной информации хранилища данных.
Работа с Oracle Discoverer Plus в
составе ИАС КХД возможна всегда, когда есть необходимость в получении
информации для анализа, контроля, мониторинга и принятия решений на ее основе.
Работа с Oracle Discoverer Plus в
составе ИАС КХД доступна всем пользователям с установленными правами доступа.
3. Подготовка к работе
В разделе «Подготовка к работе»
указывают:
1.
состав и
содержание дистрибутивного носителя данных;
2.
порядок
загрузки данных и программ;
3.
порядок
проверки работоспособности.
3.1. Состав и содержание
дистрибутивного носителя данных
Для работы с ИАС КХД необходимо
следующее программное обеспечение:
1.
Internet
Explorer (входит в состав операционной системы Windows);
2.
Oracle
JInitiator устанавливается автоматически при первом обращении пользователя к
ИАС КХД.
3.2. Порядок загрузки данных и
программ
Перед началом работы с ИАС КХД на
рабочем месте пользователя необходимо выполнить следующие действия:
1.
Необходимо
зайти на сайт ИАС КХД ias-dwh.ru.
2.
Во время
загрузки в появившемся окне «Предупреждение о безопасности», которое
будет содержать следующее: ‘Хотите установить и выполнить «Oracle JInitiator»
…’ Нажимаем на кнопку «Да».
3.
После чего
запуститься установка Oracle JInitiator на Ваш компьютер. Выбираем кнопку Next
и затем OK.
3.3. Порядок проверки
работоспособности
Для проверки доступности ИАС КХД с
рабочего места пользователя необходимо выполнить следующие действия:
1.
Открыть
Internet Explorer, для этого необходимо кликнуть по ярлыку «Internet Explorer»
на рабочем столе или вызвать из меню «Пуск».
2.
Ввести в
адресную строку Internet Explorer адрес: ias-dwh.ru и нажать «Переход».
3.
В форме аутентификации
ввести пользовательский логин и пароль. Нажать кнопку «Далее».
4.
Убедиться, что
в окне открылось приложение Oracle Discoverer Plus.
В случае если приложение Oracle
Discoverer Plus не запускается, то следует обратиться в службу поддержки.
4. Описание операций
В разделе «Описание
операций» указывают:
1.
описание всех
выполняемых функций, задач, комплексов задач, процедур;
2.
описание
операций технологического процесса обработки данных, необходимых для выполнения
функций, комплексов задач (задач), процедур.
Для каждой операции обработки
данных указывают:
1.
наименование;
2.
условия, при
соблюдении которых возможно выполнение операции;
3.
подготовительные
действия;
4.
основные
действия в требуемой последовательности;
5.
заключительные
действия;
6.
ресурсы, расходуемые
на операцию.
В описании действий допускаются
ссылки на файлы подсказок, размещенные на магнитных носителях.
4.1. Выполняемые функции и задачи
Oracle Discoverer Plus в составе
ИАС КХД выполняет функции и задачи, приведенные в таблице ниже:
|
Функции |
Задачи |
Описание |
|
Обеспечивает многомерный |
Визуализация отчетности |
В ходе выполнения данной |
|
Формирование табличных и |
В ходе выполнения данной |
4.2. Описание операций
технологического процесса обработки данных, необходимых для выполнения задач
Ниже приведено описание
пользовательских операций для выполнения каждой из задач.
Задача:
«Визуализация отчетности»
Операция 1: Регистрация на портале
ИАС КХД
Условия,
при соблюдении которых возможно выполнение операции:
1.
Компьютер
пользователя подключен к корпоративной сети.
2.
Портал ИАС КХД
доступен.
3.
ИАС КХД
функционирует в штатном режиме.
Подготовительные
действия:
На компьютере пользователя
необходимо выполнить дополнительные настройки, приведенные в п. 3.2 настоящего
документа.
Основные
действия в требуемой последовательности:
1.
На иконке «ИАС
КХД» рабочего стола произвести двойной щелчок левой кнопкой мышки.
2.
В открывшемся
окне в поле «Логин» ввести имя пользователя, в поле «Пароль» ввести пароль пользователя.
Нажать кнопку «Далее».
Заключительные
действия:
Не требуются.
Ресурсы,
расходуемые на операцию:
15-30 секунд.
Операция 2: Выбор отчета
Условия,
при соблюдении которых возможно выполнение операции:
Успешная регистрация на Портале
ИАС КХД.
Подготовительные
действия:
Не требуются.
Основные
действия в требуемой последовательности:
1. В появившемся окне «Мастер
создания рабочих книг» поставить точку напротив пункта «Открыть существующую
рабочую книгу».
2. Выбрать нужную рабочую книгу и
нажать кнопку «Откр.»:
Заключительные действия:
После завершения работы с отчетом
необходимо выбрать пункт меню «Файл», далее выбрать пункт «Закрыть».
Ресурсы,
расходуемые на операцию:
15 секунд.
Задача:
«Формирование табличных и графических форм отчетности»
Заполняется по аналогии.
5. Аварийные ситуации
В разделе «Аварийные
ситуации» указывают: 1. действия в случае несоблюдения условий выполнения
технологического процесса, в том числе при длительных отказах технических
средств; 2. действия по восстановлению программ и/или данных при отказе
магнитных носителей или обнаружении ошибок в данных; 3. действия в случаях
обнаружении несанкционированного вмешательства в данные; 4. действия в других
аварийных ситуациях.
В случае возникновения ошибок при
работе ИАС КХД, не описанных ниже в данном разделе, необходимо обращаться к
сотруднику подразделения технической поддержки ДИТ (HelpDesk) либо к
ответственному Администратору ИАС КХД.
|
Класс ошибки |
Ошибка |
Описание ошибки |
Требуемые |
|
Портал ИАС КХД |
Сервер не найден. |
Возможны проблемы с |
Для устранения проблем с |
|
Ошибка: Требуется ввести |
При регистрации на |
Ввести имя пользователя. |
|
|
Ошибка: Требуется ввести |
При регистрации на |
Ввести пароль. |
|
|
Ошибка: Сбой |
Неверно введено имя |
Нужно повторить ввод |
|
|
Сбой в электропитании |
Нет электропитания |
Рабочая станция |
Перезагрузить рабочую |
|
Сбой локальной сети |
Нет сетевого |
Отсутствует возможность |
Перезагрузить рабочую |
6. Рекомендации по освоению
В разделе «Рекомендации по
освоению» указывают рекомендации по освоению и эксплуатации, включая
описание контрольного примера, правила его запуска и выполнения.
Рекомендуемая литература:
· Oracle® Business Intelligence Discoverer
Viewer User’s Guide
· Oracle® Business Intelligence Discoverer
Plus User’s Guide
Рекомендуемые курсы обучения:
· Discoverer 10g: Создание запросов
и отчетов
В качестве контрольного примера
рекомендуется выполнить операции задачи «Визуализация отчетности», описанные в
п. 4.2. настоящего документа.
Ход
работы:
Задание 1.
Изучите
свой вариант руководства пользователя. Опишите его по следующему плану:
1) для
какого продукта, предназначено руководство пользователя (наименование, модель);
2)
основные технические характеристики продукта;
3)
основные разделы руководства пользователя (название раздела и краткое его
описание)
Задание 2.
Откройте
документ «Образец руководства пользователя», заполните в нем первые разделы для
своего вымышленного программного продукта.
Сделайте
вывод
о проделанной работе.
Контрольные
вопросы:
1) Дайте
определения понятиям «руководство пользователя», «инструкция по эксплуатации»
2) Какие
основные разделы должно содержать руководство пользователя?
3) Какие
стандарты описывают Руководство пользователя Руководство оператора, Руководство
программиста, Руководство системного программиста?
4) Что
описывает раздел «назначение системы»?
5) Что
указывается в разделе «условия применения системы»?
6) Какая
информация содержится в разделе «Описание операций»?