Чем отличается руководство пользователя от инструкции

1. Понятие руководства по эксплуатации

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

Навигация по странице:

1. Понятие руководства по эксплуатации
2. Статус руководства по эксплуатации в ряду прочих технических документов
3. Области применения руководства по эксплуатации
4. Дополнительные сферы применения РЭ

Понятие руководства по эксплуатации

Содержание термина «руководство по эксплуатации» принято трактовать в соответствии с положениями ГОСТ 2.601-2006 «Единая система конструкторской документации (ЕСКД). Эксплуатационные документы». Указанный национальный стандарт определяет данное руководство как важный документ, в котором содержится исчерпывающая информация о характеристиках продукта, его конструкции и принципах работы, правилах безопасной эксплуатации и осуществления работ с применением данного изделий.

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

Статус руководства по эксплуатации в ряду прочих технических документов

ГОСТ 2.601-2006 относит руководство по эксплуатации к разряду эксплуатационных документов наряду с инструкцией по монтажу, паспортом изделия, ведомостью наличия прилагаемых запчастей и проч. Таким образом, на данное руководство распространяются соответствующие правила Единой системы конструкторской документации (ЕСКД). В частности, это относится к положениям ГОСТ 2.610-2006 «Единая система конструкторской документации. Правила выполнения эксплуатационных документов».

Требования ГОСТ 2.601-2006 устанавливают, что разработка руководства по эксплуатации не носит обязательного характера в отношении всех без исключения видов изделий: необходимость формирования этого документа определяется самим создателем продукции с учетом сложности его использования, необходимости применения дополнительной информации для корректной настройки и применения и других факторов. При этом в данном нормативно-правовом документе имеется оговорка о том, что в случае, если разработка конкретного продукта производится по заказу Министерства обороны РФ, именно это ведомство будет выступать в качестве органа, принимающего решение о необходимости разработки руководства по эксплуатации (РЭ).

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

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

Кроме того, оно может потребоваться для получения ряда разрешительных документов:

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

Таким образом, разработка РЭ – это ответственная процедура, к которой компании-производителю необходимо подойти с должной серьезностью.

http://blog.csdn.net/luyanc/article/details/53886028?foxhandler=RssReadRenderProcessHandler

Существует множество видов предоставления справочной информации пользователю – это и FAQ (frequently asked questions, часто задаваемые вопросы) и онлайн справка и руководство пользователя (user guide) и популярные сегодня подсказки (coachmarks, см. пример ниже), обучающие видео и другие.

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

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

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

 1. Стандарты

Часто бывает нужно написать документ, который бы удовлетворял требованиям действующих стандартов. Это могут быть:

• IEEE Std 1063-2001, «IEEE Standard for Software User Documentation»;
• ГОСТ 19:
  • ГОСТ 19.402-78 ЕСПД. Описание программы;
  • ГОСТ 19.502-78 ЕСПД. Общее описание. Требования к содержанию и оформлению;
  • ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению;
  • ГОСТ 19.504-79 ЕСПД. Руководство программиста. Требования к содержанию и оформлению;
  • ГОСТ 19.505-79 ЕСПД. Руководство оператора. Требования к содержанию и оформлению.

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

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

2. Структура

Хорошо продумайте структуру документа: она должна покрывать все функциональные возможности системы, быть полной и понятной.

Хорошее руководство пользователя должно содержать:

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

Также руководство пользователя может содержать:

• FAQ и ответы на них
• Ссылки на дополнительную информацию по системе
• Раздел, описывающий возможные проблемы и пути их решения

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

3. Пользователи

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

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

Уважайте пользователей системы, не пишите инструкции в пренебрежительном стиле.

4. Особенности изложения

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

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

Для составления хорошего документа пригодятся знания грамматики и немного психологии.

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

Хорошо: In File menu, select Save item.
Хуже: Select Save item from File menu.

4.2 Используйте повелительное наклонение, не употребляйте вежливые обороты (please, could и т.д.) — излишняя вежливость именно здесь будет помехой.

Хорошо: Click Logout to log out current user account from the system.

Хуже: It is needed to click Logout to log out current user account from the system.

Хуже: If user wants to log out current user account from the system (s)he needs to click Logout. 

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

Хорошо:
To create project:

1. Click the Create button on toolbar.
2. On the Create Project overlay fill in all mandatory fields.
3. Click the Save button to save the project.

Хуже: To create project click the Create button on toolbar, on the Create Project overlay fill in all mandatory fields, click the Save button to save the project.

4.4 Не используйте будущее или прошлое время.  Например, часто встречаются руководства, в которых реакция системы на действие пользователя передается фразами, сформулированными в будущем времени. У ПО нет прошлого или будущего: всё случается в настоящем как прямой результат конкретного действия пользователя. Как только событие случается, ПО реагирует.

Хорошо: When user clicks the Start button, the program starts the process.

Хуже: When user clicks the Start button, the program will start the process.

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

Например, глагол «press» означает нажатие клавиши на клавиатуре, а «click» – нажатие кнопки или значка в окне программы при помощи мыши, а «hit» вообще является жаргонным словом.

Разумеется, орфографические ошибки недопустимы.

4.6 Не используйте синонимы для одного и того же термина. В IT литературе на английском (или любом другом) языке есть стандартный набор глаголов, обозначающих действия (click, double-click, select, type, press и т.д.) и такой же стандартный набор названий элементов управления. Определитесь с терминологией и придерживайтесь ее в рамках всего документа.

Например, не допускайте, чтобы в одной части документа выпадающий список назывался dropdown, а в другой точно такой же элемент – combobox или dropdown list. Это путает пользователя.

4.7 Разумно используйте сокращения и исключите жаргон.

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

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

5. Внешний вид

5.1 Продумайте стиль документа. Это может быть корпоративный шаблон или цветовая схема ПО или специально сделанный для документа дизайн.

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

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

5.3 Используйте пиктограммы и иллюстрации. Существует мнение, что не стоит увлекаться иллюстрациями, а также включать в текст пиктограммы (icons) в руководстве пользователя. Однако графическая информация всегда лучше воспринимается и запоминается, поэтому снимки экрана и нужные пиктограммы должны присутствовать в хорошем руководстве в достаточном, но разумном количестве.

6. Поддержка

Не упускайте из виду тот факт, что ПО со временем меняется, а значит, ваш документ тоже должен меняться, чтобы оставаться актуальным.

Заключение

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

Помните главное: документ должен помогать пользователям.

Статью подготовила

Тарасюк Надежда, участник сообщества analyst.by,

аналитик с 6-летним опытом в сфере.

Аннотация. В данной статье рассмотрены особенности разработки руководства пользователя для программного обеспечения «Зарплата и кадры». Автором изучены назначение и структура руководства пользователя. 

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

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

Основная цель документа «Руководство пользователя» заключается в обеспечении пользователя необходимой информацией для самостоятельной работы с программой или автоматизированной системой. Документ должен отвечать на следующие вопросы: назначение программы, её возможности; что необходимо для обеспечения ее корректного функционирования и, что делать в случае отказа системы [1].

В статье приводится пример структуры «Руководства пользователя» для программного  обеспечения «Зарплата и кадры», используемого в Инновационном Евразийском университете (ИнЕУ).

«Руководство пользователя» должно состоять из двух частей:

• руководство пользователя;
• руководство оператора.

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

1. Введение. Данный    раздел    должен    предоставлять    пользователю    общую    информацию о приложении. Введение должно состоять из следующих подразделов:

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

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

1. Назначение и   условия   применения.   Раздел   подразделяет   основную   задачу    приложения на подзадачи и описывает каждую из них.

• Виды деятельности и функции. В этом подразделе описываются функции, для автоматизации которых предназначена программа.
• Условия применения. В подразделе описываются условия, при которых обеспечивается полноценное применение программного обеспечения. В качестве таких условий могут выступать требования к аппаратному  обеспечению,  на  котором  будет  использоваться  программное  обеспечение, и квалификация сотрудников, которые будут работать с описываемым программным  продуктом. Например,  для  корректной  работы   программного   обеспечения   «Зарплата   и   кадры» рекомендовано не выполнять на компьютере параллельно других ресурсоемких задач [2]. 

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

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

1. Проверка работоспособности. В подразделе описываются показатели, по которым можно определить, что программное обеспечение работает нестабильно. Процесс проверки программного обеспечения «Зарплата и кадры» требует определенного промежутка времени, так как необходимо протестировать большое количество различных функций при различных условиях.
2. Описание операций. Это основной раздел, который содержит пошаговую инструкцию для выполнения того или иного действия пользователем. Если работа автоматизированной системы затрагивает целый бизнес-процесс, то в руководстве пользователя перед описанием операций целесообразно предоставить информацию о данном процессе, его назначении и участниках. Подобное решение позволяет человеку четко представить свою роль в данном процессе и те функции, которые реализованы для него в системе. Далее в руководстве пользователя следует представить  описание функций, разбитых на отдельные операции. Необходимо выделить подразделы, описывающие функции данного процесса, и действия, которые необходимо совершить для их выполнения.

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

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

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

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

1. Установка а сервер. Программное обеспечение «Зарплата и кадры» является многопользовательским, следовательно, оно имеет централизованную базу данных. В разделе описывается процесс установки программного обеспечения на сервер. Пошаговая инструкция дает точные указания, каким образом необходимо выполнить установку, в зависимости от технического состояния сервера. Настройка сервера для обеспечения работоспособности программного приложения «Зарплата и кадры» является основным моментом администрирования, так как сервер хранит большие объемы различной информации.
2. Установка локальная. В разделе описывается процесс настройки компьютеров, использующих программное приложение, также даются рекомендации по оптимизации настройки рабочих станций, чтобы улучшить процесс взаимодействия сервера и компьютеров пользователей.
3. Администрирование пользователей. В разделе подробно описывается процесс администрирования учетных записей пользователей программного обеспечения «Зарплата и кадры». Подробная инструкция описывает все   ситуации,   которые   могут   возникнуть   при   управлении   пользователями.   Например, с помощью   данной    подсистемы    можно    централизованно    завершать    все    активные    соединения с информационной базой и устанавливать блокировку новых соединений на определенный  период времени.   Такая    возможность    полезна    при    выполнении    различных    административных действий с информационной базой.
4. Информационная база. В разделе рассматриваются вопросы администрирования, сохранения, переноса базы данных. Описаны рекомендации по настройке базы данных. Например, рассматривается ситуация резервного копирования. Программное обеспечение «Зарплата и кадры» позволяет создавать резервные копии информационной базы. Резервное копирование может выполняться как в автоматическом режиме, так и в ручном. Для автоматического режима предварительно необходимо выполнить настройки. В любой момент можно восстановить данные информационной базы из созданной ранее резервной копии.
5. Технические неполадки. Этот раздел содержит информацию о возможных технических проблемах, которые могут возникнуть в процессе эксплуатации программного обеспечения. Рассматриваются проблемы, возникающие в результате некорректной работы оборудования, а также ситуации, возникающие в результате некорректного использования функций программного обеспечения «Зарплата и кадры». 

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

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

СПИСОК ЛИТЕРАТУРЫ

1. Радченко М.Г. 1С: Предприятие 0. Практическое пособие разработчика. Примеры и типовые приемы . – 1С – Паблишинг, 2004. – 656 с.
2. Тимофеев Г., Шумейко Д. Конфигурирование и администрирование 1С: Предприятия. – Ростов н/Д: Феникс, 2003. – 320 с.

Научные статьи на тему «Руководство (инструкция по эксплуатации)»

Эксплуатация газораспределительных сетей

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

Статья от экспертов

ФУНКЦИОНАЛЬНО-СЕМАНТИЧЕСКИЙ АНАЛИЗ КОЛЛОКАЦИЙ В НОВЫХ ТИПАХ ИНСТРУКЦИЙ ПО ЭКСПЛУАТАЦИИ (НА МАТЕРИАЛЕ ИНСТРУКЦИИ «ДЛЯ ЧАЙНИКОВ» (FOR DUMMIES))

Введение. Работа посвящена выявлению и анализу коллокаций в новой жанровой разновидности инструкции по эксплуатации For Dummies. Актуальность данного исследования определяется возрастающим интересом к изучению функционально-речевого аспекта языка в целом, а также отсутствием специальных исследований типов коллокаций в новых видах инструкций. Цель работы состоит в определении типов коллокаций, их семантики и функции в текстах новых инструкий по эксплуатации (на примере инструкции For Dummies). Материал и методы функционально-семантический анализ. Материалом исследования послужили тексты инструкции «для чайников» (For Dummies). Результаты и обсуждение. Анализ показал, что новые инструкции отличаются от традиционных инструкций по эксплуатации с использованием экспрессивных и окказиональных коллокаций. Наличие узуальных и терминологических коллокаций, с одной стороны, сближает новые инструкции с традиционными инструкциями по эксплуатации. С другой стороны, функционирование окказиональны…

Техническая эксплуатация электромеханического и электротехнического оборудования

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

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

Статья от экспертов

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

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