Как создать лучшую пользовательскую документацию

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

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

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

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

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

Вот что вы узнаете:

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

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

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

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

Если вы когда-либо собирали мебель ИКЕА, вы использовали документацию конечного пользователя.

Однако пользовательская документация принимает множество форм.

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

Налоговые формы снабжены инструкциями по их правильному заполнению.

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

Перейти к тому, как сделать пользовательскую документацию

Почему важна пользовательская документация?

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

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

Пользовательская документация может порадовать ваших клиентов

Пользовательская документация проста, верно? Я имею в виду, просто напишите немного о том, как использовать ваш продукт, и все готово!

Это не так просто.

Это больше, чем просто практический материал. Это часть клиентского опыта. А это значит, что это еще и маркетинговый материал.

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

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

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

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

Как пользовательская документация помогает вашей команде поддержки

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

1. Дает им простое справочное руководство

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

2. Сокращает количество звонков

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

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

Каковы основные элементы отличной пользовательской документации?

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

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

• Простой язык
• Простота
• Визуальные эффекты
• Фокус на проблеме
• Логическая иерархия и поток
• Содержание
• Доступный для поиска контент
• Доступный контент
• Хороший дизайн
• Отзывы реальных пользователей
• Ссылки на дополнительные ресурсы

Простой язык

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

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

Помните, пишите для пользователя, а не для разработчика.

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

Но тут можно столкнуться с серьезными неприятностями.

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

Не пишите так, как будто они дети, но помните, что им может понадобиться дополнительная помощь, чтобы по-настоящему освоить их. Пишите документацию в удобном для чтения виде.

Простота

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

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

Визуальные эффекты

Лучшая пользовательская документация прекрасно иллюстрирует фразу «покажи, а не рассказывай».

Визуальный контент, включая изображения, аннотированные скриншоты, графику и видео, быстро показывает кому-то, как работает ваш продукт. Им не нужно об этом читать: они могут это увидеть!

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

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

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

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

Итак, что-то похожее на это:

Теперь выглядит так:

Если бы я пытался показать кому-то, как выбрать пункт меню «Подключить мобильное устройство», второе изображение убрало бы весь беспорядок и позволило бы глазам клиента сфокусироваться там, где им нужно быть.

Скорее всего, вы уже сталкивались с упрощенной графикой и даже не осознавали этого, как это из Центра обучения G Suite:

Существует множество инструментов, но если вы ищете мощные и простые способы создания снимков экрана и записи экрана, я настоятельно рекомендую загрузить бесплатную пробную версию Snagit.

Сосредоточьтесь на проблеме, которую нужно решить

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

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

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

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

Вот отличный пример…

Логическая иерархия и поток

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

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

Оглавление

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

Сделать его доступным для поиска

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

Как и оглавление, контент с возможностью поиска упрощает доступ пользователей к вашему контенту и помогает им самостоятельно находить решения.

Доступность

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

Помните, что многим вашим клиентам это необходимо для понимания и полного доступа к вашей пользовательской документации. Не оставляйте их позади!

Хороший дизайн

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

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

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

Используйте согласованные шрифты и дополнительные цвета в нескольких документах. Если в вашей организации есть руководство по стилю (которое я НАСТОЯТЕЛЬНО рекомендую создать, если оно еще не существует), убедитесь, что ваша документация соответствует ему.

Шаблоны Snagit позволяют невероятно легко создавать профессионально выглядящую пользовательскую документацию из серии скриншотов или других изображений. Просто соберите нужные изображения, выберите «Создать», а затем «Изображение из шаблона», и все готово.

Snagit поставляется с набором бесплатных профессионально разработанных шаблонов, а с TechSmith Assets for Snagit вы получаете доступ к гораздо большему!

Отзывы реальных пользователей и/или бета-тестеров

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

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

Ссылки на другую документацию

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

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

Бонус! Добавить пошаговую инструкцию

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

И помните, включение визуального контента в ваши пошаговые инструкции делает их еще лучше.

Snagit предоставляет простой в использовании инструмент Step Tool, который поможет вам создать отличную пошаговую документацию. Кроме того, инструмент «Объединить изображения» позволяет объединять отдельные снимки экрана и другие изображения в одно изображение для упрощения редактирования и разметки.

Как создать отличную пользовательскую документацию

Шаг 1: План

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

Знайте, с чего начать

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

Прежде чем создавать документацию, необходимо учесть несколько моментов:

• Что вы должны включить? Что вы должны исключить? (Подсказка: здесь отзывы пользователей могут быть ДЕЙСТВИТЕЛЬНО полезными!)
• В каком порядке мы должны представить информацию? (Помните школьные схемы сочинений? Используйте их!)
• Какие еще ресурсы будут доступны? Как мы будем предоставлять доступ/ссылки на них?
• Кто отвечает за создание документа? Кто отвечает за обратную связь по документу? У кого есть окончательное одобрение?
• Это нужно будет переводить или локализовать?

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

Знай свой продукт

Убедитесь, что вы знаете свой продукт.

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

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

Выберите свой формат

Кроме того, окончательный формат документа не менее важен. Это будет только печать? Будет ли он электронным? Если да, то где он будет жить?

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

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

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

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

Кроме того, электронную документацию намного проще обновлять, поскольку она находится в сети.

Должен ли я сделать свою документацию в формате PDF?

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

Шаг 2: Создайте свой пользовательский документ

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

• Избегайте жаргона и технических терминов, за исключением случаев крайней необходимости (и тогда обязательно дайте им определение).
• Избегайте аббревиатур, если вы не объясняете, что они означают.
• По возможности используйте общепризнанный стиль письма, например, AP или Chicago. Если в вашей организации есть руководство по фирменному стилю, используйте его.
• Не предполагайте, что пользователь знает что-либо о вашем продукте или о том, что он делает. ПОКАЖИТЕ им, что им нужно знать, чтобы добиться успеха.
• Не забывайте использовать простой язык. Пишите для уровня восьмого класса или ниже. Даже для продвинутых читателей простой язык приводит к более быстрой обработке и лучшему пониманию.
• Дизайн должен быть приятным, не пугающим и привлекать пользователя. Сделайте так, чтобы он захотел использовать вашу документацию.

Шаг 3: Протестируйте

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

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

Шаг 4. Обновляйте документацию

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

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

Резюме

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

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

Сделайте свою документацию доступной, полезной и наглядной.

Часто задавайте вопросы