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

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

¶Назначение и место в документации

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

В состав эксплуатационной документации, помимо руководства пользователя, входят:

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

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

¶Типы руководств

По целевой аудитории и глубине изложения выделяют несколько разновидностей:

¶Структура

Типовое руководство пользователя строится по схеме, рекомендуемой стандартами оформления технической документации:

1. Общие сведения — назначение изделия, комплектность, требования к условиям эксплуатации.
2. Безопасность — предупреждения, знаки безопасности, допустимые режимы работы.
3. Подготовка к работе — распаковка, установка, подключение, первичная настройка.
4. Основные функции — описание интерфейса, порядок выполнения типовых операций.
5. Дополнительные функции — расширенные возможности, необязательные настройки.
6. Устранение неисправностей — типовые отказы, коды ошибок, рекомендации по восстановлению.
7. Технические характеристики — параметры, габариты, потребляемая мощность.
8. Приложения — словарь терминов, таблицы соответствия, образцы форм.

¶Оформление и стандарты

В России порядок оформления эксплуатационной документации регулируется межгосударственными стандартами серии ГОСТ ЕСКД (Единая система конструкторской документации). Ключевыми являются:

• ГОСТ 2.601 — эксплуатационные документы;
• ГОСТ 2.603 — правила выполнения эксплуатационных документов;
• ГОСТ 2.604 — руководство по эксплуатации.

Стандарты устанавливают состав разделов, правила иллюстраций, обозначение предупреждений, формат таблиц и перечень обязательной информации. Для программной продукции разработан отдельный стандарт ГОСТ Р ИСО/АСТМ 16990, адаптирующий международные рекомендации по созданию пользовательской документации.

На международном уровне аналогичную роль играют ISO/IEC/IEEE 26514 (требования к разработке документации для пользователей и разработчиков) и ISO 9126 (оценка качества программной документации).

¶Язык и стиль изложения

Руководство пользователя пишется в научно-техническом стиле с элементами инструктивного. Требования к тексту:

• безличные конструкции и повелительное наклонение («Нажмите кнопку», «Установите переключатель в положение А»);
• отсутствие оценочных суждений и маркетинговых формулировок;
• единообразие терминологии (термин из глоссария не заменяется синонимом);
• короткие предложения, один абзац — одна операция;
• обязательное сопровождение действий иллюстрациями с нумерацией элементов.

¶Средства создания

Для подготовки руководств используются текстовые редакторы (Microsoft Word, LibreOffice Writer), системы вёрстки (LaTeX, Adobe FrameMaker), системы управления технической документацией (MadCap Flare, «Солидор»). Для интерактивных руководств применяются форматы HTML Help, Qt Help, DITA XML, а также встроенные в продукт системы справки (форматы WinHelp, CHM, HelpNDoc).

¶Электронные руководства

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

¶Критерии качества

Основные признаки качественного руководства пользователя:

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

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

¶Историческая справка

Практика сопровождения изделий инструкциями появилась вместе с массовым производством: первые руководства по эксплуатации выпускались к сельскохозяйственным машинам и швейным машинам в конце XIX века. Стандартизация документации началась в XX веке: в СССР ЕСКД была введена в 1968 году, в США аналогичную роль играло MIL-STD-400. С развитием программных продуктов в 1980-е годы сформировалась отдельная профессия технического писателя.

¶Источники

• ГОСТ 2.601-2019. ЕСКД. Эксплуатационные документы.
• ГОСТ 2.604-2019. ЕСКД. Руководство по эксплуатации.
• ГОСТ Р ИСО/АСТМ 16990-2019. Программная документация.
• ISO/IEC/IEEE 26514:2018. Systems and software engineering — Requirements for designers and developers of user documentation.
• Сборник «Техническая документация: стандарты и практика», М.: Издательство стандартов.