Руководство пользователя

Материал из Гостопедии
Перейти к навигации Перейти к поиску

Руководство пользователя — документ в составе комплекта рабочей документации на автоматизированную систему. Предусмотрен КСАС. Разрабатывается на стадии рабочей документации.

Стандарты

ГОСТ 34.201— 2020, п. 3

Общие сведения о документе

Стадия создания Код документа Часть проекта Принадлежность к Дополнительные указания
проектно-сметной документации эксплуатационной документации
РД И3 ОО Х

ГОСТ Р 59795—2021, п. 6.4


Требования к содержанию документов с решениями по организационному обеспечению

1. Документ «Руководство пользователя» должен содержать разделы:

  • введение;
  • назначение и условия применения;
  • подготовка к работе;
  • описание операций;
  • аварийные ситуации;
  • рекомендации по освоению.

2. В разделе «Введение» приводят:

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

3. В разделе «Назначение и условия применения» приводят:

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

4. В разделе «Подготовка к работе» приводят:

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

5. В разделе «Описание операций» приводят:

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

6. Для каждой операции приводят:

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

7. В разделе «Аварийные ситуации» приводят:

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

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

Шаблоны

Шаблон Описание
Филогост Комплект шаблонов и пустографок для Microsoft Word