Запросить демо
Запросить демо

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

10.11.2023

Содержание статьи:

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

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

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

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

Начнем с общего определения. Руководство пользователя (РП) – это документ обзорного и одновременно справочного характера, основная цель которого помочь пользователям понять ИТ-продукт.

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

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

Виды руководств пользователя

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

  • руководство пользователя,
  • руководство оператора,
  • руководство программиста и 
  • руководство системного программиста.

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

Документ входит в состав эксплуатационной документации на автоматизированную систему (ГОСТ 34). Его цель состоит в том, чтобы предоставить пользователю возможность самостоятельно (без помощи службы поддержки) решать рабочие задачи. 

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

Наличие РП регламентируется ГОСТ 34.201, а структура и содержание – РД 50-34.698. 

Помимо РП существуют руководства более узкого назначения, а именно: руководство оператора, руководство программиста, руководство системного программиста. Их структура и содержание регламентированы ГОСТ 19.505-79, ГОСТ 19.504-79 и ГОСТ 19.503-79 соответственно.

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

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

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

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

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

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

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

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

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

Структура и содержание документов Руководство оператора, Руководство программиста, Руководство системного программиста регламентированы ГОСТ 19.505-79, ГОСТ 19.504-79 и ГОСТ 19.503-79 соответственно.

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

Создание руководства пользователя, в первую очередь, предполагает решение задач по структурированию документа. Логичная структура поможет читателю легко ориентироваться в документе.

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

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

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

Также необходимы такие разделы, как «Часто задаваемые вопросы» и «Устранение типовых проблем». Для наполнения данных разделов контентом понадобится информация от разработчиков (они способны спрогнозировать возможные вопросы), а также результаты обратной связи от пользователей. Это позволит выяснить, наиболее «проблемные» места продукта.

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

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

Советы по созданию руководства пользователя

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

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

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

  • Где пользователь будет работать с вашим РП: дома, на работе, в машине?
  • Как часто он будет к нему обращаться?
  • Насколько сложен для понимания ваш ИТ-продукт?

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

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

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

Помните, что излишне стилистически окрашенные слова (ИТ-жаргон) не способствуют усвоению материала. Поэтому лучше выбирать нейтральную лексику. По возможности старайтесь избегать технических терминов – это позволит улучшить такой параметр текста как удобочитаемость.

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

Ключевым элементом в процессе составления и управления всем спектром технических документов, включая руководства для пользователей, является применение передовых инструментов для автоматического создания и редактирования технической документации. Документерра представляет собой надежную облачную платформу, которая облегчает интегрированный подход к работе с документами, начиная от их создания и заканчивая публикацией. Здесь можно создавать различные виды документов от файлов помощи (help-файлов), on-line руководств пользователя, инструкций, пособий, документации к программному обеспечению, изделиям до баз знаний.

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

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

* * *

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

Обновление платформы!
AI-возможности и новый редактор главной страницы доступны уже сейчас.