Скачать руководство пользователя про

Здесь представлено Руководство пользователя в .pdf-формате в девяти Частях, соответствующее требованиям ГОСТов серий 19 и 34 ЕСПД к содержанию основных эксплуатационных документов: Руководству оператора, Формуляру, Описанию применения, к Руководству системного программиста; а также соответствующее базовым требованиям Национального стандарта РФ ГОСТ Р 7.0.97-2016.

Изменения в указанной выше новой версии ПО могут отражаться не во всех частях Руководства.

Руководство
пользователя как программная
(эксплуатационная) документация
пользователя

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

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

Документация:
программная/эксплуатационная/документация
пользователя

Предмет:
программа,
программный компонент комплекса
или системы

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

Задачи:
обеспечить пользователям возможность
в полном объеме самостоятельно освоить
и применять программу

Руководящими
стандартами для создания документа
Руководство пользователя  могут
являться как РД
50-34.698-90 в п.п. 3.4. «Руководство пользователя»,
так и ГОСТ
19.505-79 «Руководство оператора. Требования
к содержанию и оформлению».

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

• Назначение
  системы;

• Условия
  применения системы;

• Подготовка
  системы к работе;

• Описание
  операций;

• Аварийные
  ситуации.

Назначение
системы

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

Пример:

«Корпоративный
интранет портал предназначен для
повышения корпоративной культурыр
организации эффективного взаимодействия
сотрудников.  

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

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

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

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

• Квалификация
  пользователя – данный подраздел должен
  содержать требования к навыкам и знаниям
  пользователя (пример:
  «Пользователи должны обладать умениями
  работать с операционной системой
  Windows»);

Подготовка
системы к работе

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

Описание
операций

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

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

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

Пример:

«4.1
Согласование проекта

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

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

4.1.1
 Создание проекта

Для
того чтобы создать Проект необходимо
на панели «…» нажать на кнопку «…» и в
появившейся форме заполнить следующие
поля:

• Наименование
  проекта;

• Описание
  проекта;

Следующие
поля заполняются автоматически:

• Дата
  создания проекта – текущая дата;

• Автор
  – ФИО и должность автора проекта.»

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

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

Аварийные
ситуации

Данный
раздел документа Руководство пользователя
должен содержать пошаговые инструкции
действий пользователя в случае отказа
работы Системы. Если к пользователю не
были предъявлены особые требования по
администрированию операционной системы
и т.п., то можно ограничиться фразой «При
отказе или сбое в работе Системы
необходимо обратиться к Системному
администратору».

Методика
и стиль изложения руководства пользователей

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

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

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

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

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

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

Соседние файлы в папке Лекции_МПО_ч2

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