Как писать понятные и краткие руководства пользователя
Что такое руководство пользователя?
Существуют различные названия руководства пользователя. Технические документы, руководства по техническому обслуживанию и инструкции по эксплуатации — все это названия, которые относятся к одному и тому же элементу. Руководство пользователя создано, чтобы помочь клиентам правильно использовать ваш продукт или услугу или решать проблемы, возникающие во время использования. Они могут быть доступны в печатном, цифровом или обоих форматах.
Руководства пользователя предоставляют конечному пользователю исчерпывающие пошаговые инструкции и некоторую поддержку в решении проблем. Оглавление должно присутствовать в каждом руководстве пользователя, поскольку это справочные материалы, а не книги, которые следует читать от начала до конца. Вам следует добавить в руководство пользователя краткое руководство или руководство по началу работы, чтобы пользователи могли легко начать использовать продукт.
виды руководств пользователя
Руководства пользователя могут быть созданы для различных предметов и целей. Вот некоторые из ваших возможностей, давайте рассмотрим их.
- Руководство по эксплуатации
Инструкция по эксплуатации — это тип руководства пользователя, в котором содержатся простые инструкции по использованию продукта в соответствии с его предназначением. - Руководство по обучению
Такое руководство пользователя предлагает список рекомендаций по выполнению определенной задачи, проекта или работы. - Руководство по эксплуатации
Руководства по техническому обслуживанию — это руководства пользователя, в которых описывается, как ухаживать за машиной или оборудованием и обслуживать их в различных условиях.tages его продолжительности жизни. - Руководство пользователя
Руководства пользователя — это технические публикации, в которых объясняется, как правильно использовать или эксплуатировать продукт. - Руководство по эксплуатации
Роли, обязанности и процедуры, характерные для предприятия или организации, описаны в руководствах по эксплуатации. - Руководство по организационной политике
Руководство по организационной политике — это документация, определяющая политику, практику и передовой опыт компании. - Руководство по стандартным операционным процедурам (СОП)
Пользователи получают подробные инструкции по выполнению установленных процедур, содержащиеся в руководстве по стандартным рабочим процедурам.
Зачем вашему бизнесу нужны руководства пользователя?
Люди лучше подготовлены к решению проблем самостоятельно с помощью руководства пользователя. Хорошее руководство пользователя может предоставить вашим клиентам инструменты, необходимые для быстрого и эффективного достижения желаемой ценности от вашего продукта или услуги в сегодняшней культуре немедленного удовлетворения.
Отличное обслуживание клиентов должно быть дополнено руководствами пользователя. Написание отличных руководств пользователя обеспечит следующее преимуществоtagдля вашей компании:
- Упростить адаптацию и обучение
Хорошо написанные руководства пользователя могут упростить процедуры адаптации и обучения. Это верно, разрабатывая и внедряя первоклассные руководства пользователя, выиграют и ваши сотрудники, и ваши потребители.
Ваша компания может использовать руководства пользователя, чтобы помочь новым сотрудникам пройти через некоторые процессы и системы, которые являются частью их новых ролей, а не только организовывать сложные очные сессии обучения, которые требуют значительных временных и финансовых затрат. Поскольку сотрудники могут учиться, выполняя обязанности, связанные с их должностями, благодаря руководствам пользователя, может быть меньше потерянных часов во время адаптации. - Чтобы сократить расходы на поддержку
Руководства пользователя являются отличным дополнением к вашим усилиям по обслуживанию клиентов, но они также полезны владельцу бизнеса как компонент системы поддержки клиентов.
Клиенты с большей вероятностью смогут сразу найти решение и реже будут обращаться к техническому специалисту или представителю для получения специализированной поддержки, если вы предоставите им быстрый доступ к руководству пользователя с возможностью поиска. - Для экономии времени
И ваши клиенты, и ваши сотрудники, от начального уровня до руководства, могут сэкономить время, используя руководства пользователя. Когда руководства пользователя доступны вашим клиентам, им не придется тратить время на поиск информации о том, как использовать продукт, поскольку они сразу получат прямой доступ к этой информации.
Когда ваши сотрудники снабжены полезными руководствами пользователя, им не придется тратить время на самостоятельный поиск решений или отвлекать внимание коллег и руководителей вопросами, поскольку у них есть доступ к решениям прямо в руководстве пользователя! - Чтобы минимизировать ответственность
Один из подходов к демонстрации того, что вы тщательно протестировали свой продукт и знаете, как его безопасно использовать, — это написание и распространение руководств пользователя. Это может значительно снизить любые обязательства, связанные с производством чего-либо для широкой публики.
Наличие предупреждений и мер предосторожности, записанных и доступных пользователям в руководстве пользователя, является эффективным (хотя и не надежным) способом избежать юридических проблем, связанных с травмами или другим ущербом, вызванным неправильным использованием, если продаваемый вами продукт может быть опасен для пользователей (например, обогреватели, электроинструменты и т. д.).
Какие компоненты входят в состав лучших руководств пользователя?
Существуют некоторые рекомендации по составлению пользовательской документации, которых следует придерживаться в любом случае, даже несмотря на то, что каждый продукт уникален и для создания действительно превосходной пользовательской документации потребуются отдельные компоненты.
- Понятный язык
Ничто не будет раздражать ваших клиентов больше — помимо того, что вы его не предлагаете — чем обнаружение того, что их руководство пользователя переполнено жаргоном и сложным для понимания языком. Ваши инструкции для пользователя сложны в использовании из-за такого выбора языка, который также не способствует выдающемуся обслуживанию клиентов. Обеспечение того, чтобы вы писали для пользователя, а не для разработчика, является важнейшим компонентом создания отличных руководств пользователя. Не предполагайте, что ваш конечный пользователь знает или знаком с чем-либо. Сокращения, жаргон и офисная терминология заставят ваших клиентов чувствовать себя дезинформированными, разочарованными и неподготовленными. Золотая середина при создании руководства пользователя — это достижение баланса между тем, чтобы не писать так, как будто ваши потребители — дети (если, конечно, это не так!), и предоставлением им дополнительной помощи, необходимой для полного понимания того, как использовать продукт, простым языком. - Простота
Написание руководства пользователя требует соблюдения простоты. Эта концепция должна быть отражена как в содержании, так и в дизайне. Если вы перегрузите свою документацию замысловатыми картинками и длинными отрывками текста, она будет казаться слишком сложной и трудной для понимания. Такого рода руководство пользователя, скорее всего, напугает вашего пользователя и заставит его позвонить в вашу службу поддержки, а не попытаться разобраться со своей проблемой самостоятельно. - Визуальные эффекты
Принцип «Показывай, а не рассказывай» является краеугольным камнем написания руководств пользователя. Аннотированные снимки экрана, фильмы и другой визуальный контент чрезвычайно полезны для понимания концепций. Часто гораздо полезнее увидеть что-то в действии, чем читать об этом. Визуальные эффекты не только разбивают длинные отрывки текста, но и сокращают объем текста в руководствах пользователя, который может быть пугающим. Было показано, что люди запоминают визуальную информацию на 7% быстрее, чем письменную. В исследовании Techsmith также было показано, что 67% людей выполняли задачи более эффективно, когда им давали инструкции, включавшие аннотированные снимки экрана, а не только слова для передачи информации. - Сосредоточьтесь на проблеме, которую необходимо решить
Вполне вероятно, что кто-то купил ваш продукт, чтобы решить проблему. Важно сосредоточиться на этой проблеме при составлении руководства пользователя, которое будет включено в продукт. Вместо того чтобы перечислять и обсуждать все функции, предлагаемые вашим продуктом, или интригующие элементы дизайна, которые вы включили, информируйте своих пользователей о них таким образом, чтобы облегчить использование продукта. Поместите решаемую проблему в контекст функций и преимуществ вашего продукта при их описании. - Логический поток и иерархия
Чтобы пользователю было ясно, что он узнает из каждого раздела вашего руководства пользователя, используйте заголовки и подзаголовки, которые следуют четкой иерархической структуре. Чтобы без усилий провести своих клиентов через все, что им нужно знать от начала до конца, выбранная вами иерархия должна следовать логическому потоку. Убедитесь, что вы начинаете с основ и включаете логическое развитие к более сложным функциям вашего продукта. - Список содержания
Ваше руководство пользователя будет наиболее полезным для читателей, если оно начинается с оглавления. Не нужно копаться во многих страницах информации, не связанной с текущей проблемой, с которой они сталкиваются, это привычный подход для кого-то, чтобы быстро и легко изучить документ. - Сделайте его доступным для поиска
Даже если вы можете распечатать свои руководства пользователя, вполне вероятно, что цифровая документация будет вашим главным приоритетом. Вполне вероятно, что ваши руководства пользователя будут использоваться чаще всего в цифровом формате в мире, где большинство людей всегда имеют при себе смартфон. Добавление функции поиска в ваши цифровые руководства пользователя будет способствовать восхитительной простоте использования для пользователей, которые хотят решить проблему, обратившись к ней, подобно тому, как оглавление служит для направления пользователей в нужное место в печатном документе. - Доступность
Возможно, что некоторые из людей, которым требуется ваше руководство пользователя, могут извлечь пользу из дополнительной помощи, чтобы гарантировать его правильное функционирование. Независимо от того, требуются ли они законом, требования доступности, как правило, являются хорошей практикой. Поддержание требований доступности в ваших руководствах пользователя — это просто отличная деловая практика. Разработка руководств пользователя с содержанием, доступным для пользователей, которые могут иметь визуальные, звуковые или когнитивные проблемы, имеет решающее значение. - Хорошо продуманный
При создании руководств пользователя учитывайте свою аудиторию. Они будут гораздо более склонны использовать его эффективно, если вы сделаете что-то, на что им будет приятно смотреть! Избегайте использования длинных текстовых блоков и предоставьте много свободного пространства. Сочетание этих двух характеристик может помочь потребителям казаться менее пугающими и сделать изучение чего-либо нового захватывающим, а не угрожающим. Подход «показывай, а не рассказывай», который мы описали ранее, также применим здесь. Как для печатных, так и для цифровых руководств пользователя добавление визуальных материалов и фотографий в текст является великолепной альтернативой. Для цифровых руководств пользователя видео и GIF-файлы предлагают интерес и полезный элемент. Если у вашей компании есть руководство по стилю, ваш дизайн должен ему соответствовать; в противном случае, если вы работаете без него, крайне важно, чтобы ваше руководство пользователя было единообразным. Шрифт и цветовые схемы, используемые во всей статье, а в идеале и во всех ваших руководствах пользователя, должны быть единообразными. - Комментарии реальных клиентов или бета-тестеров
Вы не сможете определить, насколько успешны подготовленные вами руководства пользователя, пока не получите и не выслушаете отзывы людей, которые действительно будут использовать ваш продукт. Руководства пользователя, которые вы разрабатываете для своего продукта, должны учитывать проблемы, которые люди испытывают с ним. Вы можете узнать что-то, что кажется совершенно очевидным, но гораздо больше шансов узнать что-то, что поможет вам понять потребности клиентов, которых вы пытаетесь охватить.
Как написать руководство пользователя?
Создание руководства пользователя — это важная задача, которая может оказать большое влияние как на вашу компанию, так и на потребителей, которым вы хотите служить. Мы упростили процесс разработки руководства пользователя, чтобы вы могли легко его освоить, поскольку он может быть утомительным.
- Определите пользователей
Поиск получателя вашего сообщения — это важный начальный шаг, как и в случае с любым другим сообщением, которое вы создаете. Целевая аудитория вашего руководства пользователя поможет вам определиться с такими вопросами, как тон, уровень детализации и способ подачи контента. Написание руководства пользователя для конечного пользователя вашего продукта существенно отличается от написания руководства для технического инженера. Самый первый шаг — определить свою аудиторию. - Сосредоточиться на проблеме
Руководства пользователя создаются для того, чтобы помогать решать проблемы или давать указания кому-то, как делать что-то новое. Вы должны точно определить, для чего предназначено ваше руководство пользователя, и убедиться, что вы сохраняете эту направленность.
Может возникнуть соблазн расширить тему и обсудить многочисленные функции или приложения для вашего продукта. Это может разочаровать пользователей и привести к звонкам в вашу службу поддержки клиентов, затуманивая подлинный ответ, который им нужен.
Если ваш клиент — потребитель, обучающийся использованию продукта, или технический специалист, которому нужно его починить, сосредоточьтесь на конкретном решении, которое ему потребуется. - Используйте последовательный подход
Инструкции вашего руководства пользователя должны быть изложены в последовательном порядке, необходимом для завершения работы. Перечислите каждый шаг в порядке начала. Затем постарайтесь выполнить задание, придерживаясь точных шагов, которые вы изложили в указанном порядке. По мере того, как вы будете проходить по своему первоначальному списку, возможно, может быть, даже вероятно, что вы найдете какие-либо stages, которых не хватает. Кроме того, вы можете обнаружить, что то, что вы когда-то считали одной задачей, на самом деле должно быть разделено на несколько действий ради ясности.
Убедитесь, что вы указали четкий результат для каждого последовательного шага, который вы выделили, прежде чем перейти к следующему этапу написания руководства пользователя. Прежде чем перейти к следующему уровню, читатели должны быть полностью уверены в том, чего они хотят добиться и как это должно выглядеть. - Карта пути пользователя
Понимание того, как ваши потребители планируют использовать ваш продукт, и упрощение этого процесса — вот цели создания руководства пользователя. Вы должны приложить усилия, чтобы понять проблему, которую потребитель пытается решить, или цель, которую он пытается достичь, используя ваше решение, а также то, как он взаимодействует с вашим бизнесом. Вы можете спланировать шаги, необходимые для того, чтобы провести клиента через процесс, используя эти детали для визуализации его пути от проблемы к решению. - Выберите шаблон
Задачу написания и разработки руководств пользователя можно сделать гораздо проще, чем вы могли бы ожидать, создав ряд шаблонов. Ваша процедура может быть упрощена, а согласованность станет гораздо более реалистичной целью.
В шаблоне руководства пользователя, помимо определения таких деталей, как шрифты (тип и размер), требования к контрастности и цветовые схемы, вы также должны включить следующее:- Площадь, отведенная для введения
- Отдельные подразделы и разделы
- Выбранный вами формат для передачи последовательности действий
- Предупреждения и предостережения
- Площадь, отведенная под заключение
- Пишите простой и понятный контент
Материал вашего руководства пользователя должен быть максимально простым и понятным. Важно продумать и проанализировать формат и содержание для ясности и удобства.
Убедитесь, что каждая фаза процесса описывает только одну задачу и использует максимально понятный и краткий язык. Обязательно соответствующим образом модифицируйте текст, пока у вас не получится руководство пользователя, содержащее только действительно необходимую информацию. - Относитесь к каждому пользователю как к новичку
Предположим, что читатель вашего руководства пользователя не имел никаких предварительных знаний о вашем продукте при его создании. Пишите так, как будто вы говорите с неспециалистом.
Любое использование жаргона или технического языка следует избегать. Конечно, будут моменты, когда этого следует избегать, но это должно быть абсолютным исключением. - Протестируйте инструкции к продукту с начинающими пользователями.
Фаза тестирования процесса создания руководства пользователя имеет решающее значение. Предмет эксперимента оказывает значительное влияние на результат.
Тестирование в идеале должно проводиться на людях, которые никогда не пользовались вашим продуктом или не видели документацию. Продвигаясь по руководству пользователя, наблюдайте за тем, как они завершают процесс, и записывайте, где они застревают. Затем информацию следует соответствующим образом обновлять.
Для работы с продуктом вашим тестерам должна быть необходима только помощь руководства пользователя. Им не нужно просить о дополнительной помощи. Руководство по СССР должно содержать всю необходимую им информацию. - Создавайте контент, используя практический подход
Необходимо приложить все усилия, чтобы предложить конкретные эксampФайлы и подробные описания любых результатов, которые пользователи могут получить после выполнения каждого шага в руководстве пользователя. Пользователь должен знать о любых отзывах, которые он может получить от продукта, а также о любых потенциальных видах или звуках, с которыми он может столкнуться по пути. - Объясняйте символы, значки и коды заранее
Вам может понадобиться использовать значки, символы или коды при написании руководства пользователя, чтобы помочь предоставить необходимые инструкции. Чтобы предотвратить путаницу или разочарование читателя, крайне важно как можно раньше указать их в руководстве пользователя.
Часто задаваемые вопросы по руководству пользователя
Что такое руководства пользователя?
Пользовательская документация — это информация, предоставляемая в форме руководств пользователя или инструкций по эксплуатации, и призванная помочь конечным пользователям успешно взаимодействовать с продуктом.
- Какие виды пользовательской документации существуют?
Физическая документация, такая как буклеты или руководства, традиционно использовалась для предоставления пользовательской документации. В наши дни руководства пользователя производятся и распространяются чаще всего в цифровом виде. - Что содержится в руководствах пользователя?
Руководство пользователя или инструкция по эксплуатации имеют хороший дизайн, четкое изложение и фокус на решении проблем. Я должен иметь оглавление, придерживаться логической иерархии и потока и предлагать контент, который доступен. Кроме того, хорошее руководство пользователя будет иметь возможность поиска и учитывать запросы пользователя.views. - Как создается пользовательский документ?
Для разработки руководств пользователя можно использовать простые шаги. Сначала необходимо определить цели руководства пользователя и разработать стратегию, которая позволит их достичь. Руководство пользователя должно быть протестировано и обновлено по мере необходимости перед публикацией. Наконец, важно поддерживать руководство пользователя в актуальном состоянии, внося изменения по мере добавления новых обновлений или изданий.