Топ-13 простых, но эффективных правил создания руководств пользователя
Руководство пользователя в первую очередь создается для поддержки пользователей в использовании продукта и решении проблем. Безупречные руководства пользователя и поддержка клиентов имеют важное значение при многих покупках, и именно поэтому создание руководства пользователя — это не разовая работа.
Напротив, это непрерывный проект, продолжающийся до тех пор, пока существует продукт. Поэтому актуальные и легкодоступные руководства и интерактивные руководства пользователя необходимы для любого бизнеса. Жизненный цикл руководства пользователя мы обсудим в отдельной статье, а в этой поговорим о факторах, влияющих на полезность и популярность технической документации , которые могут привести к увеличению известности ваших услуг и продуктов.
Вот 13 лучших простых, но действенных советов, которые должен учитывать любой технический писатель при создании руководства пользователя. Мы также узнаем, как Sonat помогает нам добиться огромных результатов и создать онлайн-руководство пользователя , которое будет выделяться среди других и предоставлять нашим клиентам отличный пользовательский опыт.
1. Убедитесь, что вы полностью знаете свой продукт
Обязательно полное знание предмета, о котором вы пишете.
Вы не можете инструктировать людей, как использовать продукт и решать их проблемы, если вы не знаете его в совершенстве.
Хотя вы всегда можете обратиться к экспертам за более глубокими знаниями, вам необходимо убедиться, что вы хорошо знаете продукт и имеете практический опыт, чтобы преподавать и давать четкие инструкции.
Вы не можете инструктировать людей, как использовать продукт, если не знаете его в совершенстве.
Вот несколько советов, которые помогут вам написать простую для понимания инструкцию пользователя:
- Выполните процедуру, о которой вы пишете, шаг за шагом.
- Преподавание предмета – это разумный способ освоить его. Попробуйте обучить этой процедуре, запросите обратную связь, а затем внесите улучшения и устраните неясности на основе полученной информации.
- Не стесняйтесь обратиться за мнением эксперта, если есть детали, в которых вы не уверены на 100%.
2. Определите свою целевую аудиторию
Определение вашей целевой аудитории и адаптация к ее потребностям имеет основополагающее значение перед составлением руководства пользователя. Вам следует внимательно определиться, к кому вы обращаетесь. Учитывайте их опыт, знания, уровень профессионализма и причину, по которой они обращаются к вашему гиду.
Вашими пользователями могут быть:
- Впервые использующий; незнаком с вашим продуктом.
- Существующие клиенты, которые не знакомы с некоторыми функциями.
- Профессиональные пользователи, которые время от времени сталкиваются с неожиданными проблемами или забывают, как использовать некоторые специфические функции.
Поэтому вам нужно поставить себя на место своих пользователей, чтобы узнать, что им может понадобиться и как вы можете наилучшим образом удовлетворить их потребности. Это также поможет вам мудро выбирать слова.
Когда вы пишете для обычного пользователя, вам необходимо свести к минимуму использование технической терминологии, сокращений и жаргона, чтобы не запутать и не запугать своих клиентов. Предоставление глоссария было бы полезно, если использование технической терминологии неизбежно.
Не забывайте, что вы пишете для пользователей, которые ищут кнопку для получения вашего продукта, а не для разработчиков или экспертов. И еще раз: помните, что вы создаете руководство пользователя не для того, чтобы произвести впечатление на людей, используя громкие слова; это сделано для информирования ваших пользователей. Поэтому вы должны сделать это как можно более понятным.
Некоторые вещи могут быть очевидными для вас и других экспертов, но оставаться вопросительными для ваших пользователей. Наблюдение за реальным пользователем, использующим ваш продукт, может дать вам хорошее представление о конкретных вещах, которые вы проигнорировали.
Определите свою аудиторию, создайте образ, поставьте себя на их место и думайте так же, как они.
Вот несколько советов, которые следует учитывать при определении своей аудитории:
- Подумайте о спецификациях пользователей, их потребностях и вопросах, которые у них могут возникнуть.
- Если ваша аудитория не является технической, сведите к минимуму использование технических терминов и объясните им, если вам нужно их использовать.
- Напишите пошаговые инструкции доступным языком.
3. Используйте подходящий и последовательный стиль письма.
Выберите подходящий стиль письма. Как правило, полуформальный или формальный стиль, соответствующий установленному стандарту, может помочь вам эффективно поделиться информацией в вашем руководстве.
Помните, что это практическое руководство, основная цель которого — информировать читателей и помочь им решить проблемы, с которыми они могут столкнуться. Сейчас не лучшее время для использования юмористического тона или чрезмерной неформальности, из-за чего может быть потеряна основная мысль.
Писать активным голосом и фокусироваться на своих читателях — это важный фактор, который вы должны учитывать, поскольку его гораздо легче понять. Поскольку активный залог более четко определяет тему, это сводит к минимуму путаницу, особенно когда действие приходится выполнять самим пользователям.
Установление стандартов может помочь вам меньше беспокоиться о том, что решить, где существуют разные способы использования слов или представления иллюстраций и диаграмм.
4. Давайте конкретные и точные инструкции простым языком.
Вы пишете инструкцию, которая поможет пользователям легко ответить на их вопросы, устранить проблему или научиться правильно и безопасно использовать продукт. Давайте четкие и точные инструкции, используя простой язык.
Вот несколько советов:
- Держите это кратким. Не переполняйте предложения чрезмерными бесполезными подробностями и повторяющимися утверждениями.
- Используйте ясные и простые слова.
- Разделите сложный процесс на более мелкие части и дайте пошаговые и понятные инструкции.
5. Структурируйте и разработайте свое руководство.
Расположение и дизайн вашего руководства пользователя оказывают огромное влияние на его функциональность. Отформатируйте руководство таким образом, чтобы пользователи могли легко найти то, что им нужно. Вы можете достичь этой цели, вставив оглавление со всеми заголовками и подзаголовками на первую страницу вашего руководства.
Sonat — бесплатный онлайн-разработчик руководств пользователя . Он автоматически генерирует PDF-версию вашего руководства пользователя с оглавлением.
Используйте единообразную компоновку по всему тексту. Разработка и использование шаблона может помочь следовать тому же стандарту.
Не представляйте пугающее и запутанное руководство с перегруженным скучным текстом. Используйте разные цвета, шрифты, иллюстрации и визуальный дизайн, чтобы помочь пользователям следовать шагам и различать несколько процедур, важность других тем, предупреждений и т. д.
В конце концов, формат и дизайн вашего руководства должны придавать ему удобный вид, чтобы ваши клиенты находили его простым для понимания и привлекательным для глаз.
Использование стандартного шаблона руководства пользователя может предоставить вам подготовленный формат и дизайн, чтобы вы были на правильном пути и не пропустили важный заголовок. Это может сэкономить вам много времени и энергии.
Sonat также предоставляет вам различные возможности для создания интерактивного дизайна вашего руководства пользователя. Вы можете иметь неограниченное количество иерархических тем. Вы можете выбирать между шрифтами, стилями, цветами, блоками кавычек, блоками кода и многим другим. Пользователи имеют возможность просматривать руководство в темном или светлом режиме.
Что касается брендинга, с помощью Sonat вы можете выбрать конкретную тему, цвет фирменного оформления и логотип для каждого руководства пользователя. Вы можете начать использовать Sonat для написания документации по продукту, руководства пользователя или учебного пособия для вашей аудитории бесплатно.
6. Используйте визуальные эффекты для большей ясности
Представьте свои руководства с четкими визуальными эффектами. Обычно инструкции с визуальным контентом, включая иллюстрации, фотографии, снимки экрана, символы и короткие обучающие видеоролики, гораздо легче понять и усвоить. Только текстовые руководства могут утомить или запугать пользователей.
Более того, визуальный дизайн также может служить мерой сокращения затрат, поскольку он сокращает объем переводческих работ.
Вот несколько советов, которые следует помнить при добавлении визуальных эффектов:
- Используйте качественные фотографии.
- Используйте простые иллюстрации, а не сложные изображения.
- Вставьте короткие видеоролики.
- Добавляйте субтитры к своим видео для индексации и поиска.
Обогатите свой контент визуальными эффектами.
|
С помощью Sonat вы можете вставлять и редактировать любые визуальные эффекты. Он также позволяет легко вставлять видеоролики YouTube, Vimeo и DailyMotion в руководство пользователя.
7. Перепишите, отредактируйте и вычитайте свое руководство.
В большинстве случаев вам необходимо читать, переписывать, редактировать и корректировать любой контент, который вы создаете, перед публикацией. руководства пользователя не являются исключением.
Редактирование и доработка могут потребоваться в различных аспектах стиля и языка, включая грамматику, орфографию и пунктуацию.
Обычно команда технических писателей работает вместе над созданием отличного руководства пользователя, постоянно узнавая мнение экспертов. Кроме того, в команду может быть добавлена группа переводчиков. Когда такая группа работает над проектом, нет ничего более важного, чем делиться с командой различными типами документации для просмотра и редактирования. Чтобы все члены могли сотрудничать для одновременного улучшения текста.
Используя Sonat, вы можете воспользоваться централизованной общей платформой для работы, чтения, редактирования и совместной работы над документами. Мы оснастим его проверкой орфографии и грамматики на 18 языках.
 | Все еще сомневаетесь? Прочтите : Что такое руководство пользователя и почему оно так важно? Это ключевой секрет удовлетворения ваших пользователей! |
Sonat предоставляет вам два разных мира; «Черновой мир» на самом деле находится за кулисами, доступ к которому есть только у вас и вашей команды, и вы все можете редактировать и редактировать столько раз, сколько необходимо, прежде чем публиковать свою работу.
А еще есть «мир публикации», открытый вашим пользователям, и это то, что, наконец, видит ваша аудитория. Однако, поскольку выпуск обновлений вручную с помощью Sonat осуществляется так же просто, как нажатие кнопки публикации, вы можете редактировать, обновлять и публиковать свои новые версии. Вы всегда можете получить доступ к миру драфта, где функция истории поможет вам отслеживать все изменения.
8. Подумайте о переводе и языковой локализации.
Чтобы развивать свой бизнес, вам определенно хотелось бы произвести впечатление на своих клиентов в любой точке мира и оправдать их ожидания. Поэтому вы чаще всего решаете, чтобы ваше руководство по эксплуатации было переведено на другие языки.
Sonat дает вам возможность использовать до 184 языков в одном руководстве.
Руководство, созданное Sonat, будет отображаться вашим пользователям в зависимости от их местного языка в их браузере. Однако, если вы не предоставили перевод на этот конкретный язык, вашим пользователям будет отображаться язык вашего руководства по умолчанию.
Вот примечание, которое следует помнить при попытке обеспечить перевод вашего контента:
Не забудьте позаботиться о языковой локализации для эффективного общения. Языковая локализация — это больше, чем просто перевод, поскольку она предполагает глубокое знание целевой культуры, чтобы продукт мог эффективно адаптироваться к местным потребностям. Это можно сделать отдельным шагом после перевода. Однако привлечение профессиональных переводчиков с отличным пониманием целевого языка и культуры, предпочтительно носителей языка, всегда значительно облегчит этот процесс.
9. Включите ссылки и предоставьте ссылки на другие ресурсы.
Важным шагом является предоставление ссылок на ресурсы вашей организации, чтобы ваши пользователи могли легко получить доступ к соответствующей информации. Это может быть представлено в онлайн-руководствах, что упрощает поиск информации. Sonat позволяет легко создавать внутренние и внешние ссылки в онлайн-руководстве.
10. Попросите оставить отзыв
Вы пишете руководство пользователя, чтобы помочь клиентам легко использовать ваш продукт. Вот почему вы не можете создать идеальное практическое руководство, не получив отзывов от людей, использующих ваш продукт.
Перед публикацией
Прежде чем ваше руководство пользователя станет общедоступным, протестируйте его с участием реальных пользователей из вашей организации, бета-тестеров или даже сотрудников, наименее знакомых с вашим продуктом, и попросите оставить отзыв. Это поможет вам обнаружить свои болезни при удовлетворении их потребностей.
Пожалуйста, обратите внимание на те части, которые могут вызвать трудности при следовании вашему руководству. Было бы полезно, если бы вы также запросили отзывы у экспертов и разработчиков. Они знают продукт лучше всех и могут дать вам ценные советы с точки зрения профессионала.
Вот еще один случай, когда Сонат может стать для вас золотым инструментом. Помните о двух отдельных мирах в Сонате, о которых мы говорили ранее; Черновик и публикация. Проект мира мог бы позволить команде авторов редактировать и улучшать бесчисленное количество раз. Что ж, этот мир не ограничивается техническими писателями и редакторами. Вы можете предоставить доступ группе бета-тестеров и попросить оставить отзыв перед публикацией своей работы.
После публикации
вы получите обратную связь после публикации руководства. Пользователи могут оставлять комментарии по каждому случаю и делиться своим опытом использования вашего продукта. Это помогает вам постоянно отслеживать мнения пользователей, распознавать ваши минусы и немедленно улучшать соответствующую часть.
11. Сделайте это доступным
После того, как вы завершили создание руководства пользователя, пришло время представить его конечным пользователям. Лучший способ распространения руководства по эксплуатации — опубликовать его в Интернете. Хотя вы также можете предложить печатную версию, онлайн-руководства имеют много преимуществ перед печатными руководствами. 
Если назвать несколько примеров, многие люди используют поиск в Интернете в поисках информации. Без сомнения, онлайн-руководства также легче обновлять и распространять. Более того, было бы лучше рассмотреть возможность доступности для ваших клиентов с ограниченными возможностями; электронные версии обеспечивают лучшую доступность для пользователей с ограниченными возможностями, такими как нарушение зрения или слабые навыки манипулирования руками.
Вы должны предоставить параметры поиска в своем руководстве, применить дружественный пользовательский интерфейс (UI) и убедиться, что оно хорошо выглядит на планшетах и мобильных телефонах. Sonat может предоставить вам все эти функции, а также предлагает пользователям возможность загрузить PDF-версию и сохранить ее на будущее. Таким образом, ваши пользователи смогут получить доступ к руководству, даже если у них нет доступа в Интернет.
12. Поддерживайте актуальность руководства.
Поддерживайте актуальность содержания руководства. Поощряйте своих пользователей делиться своим опытом, рекомендациями и идеями. Используйте полезные отзывы и предложения по улучшению вашего контента для лучшего понимания. Это показывает вашим пользователям, что вы постоянно совершенствуете свои продукты и, что более важно, заботитесь и уважаете их идеи.
В этом отношении онлайн-руководства имеют значительное преимущество, поскольку обновленные версии могут быть доступны каждому одним щелчком мыши.
13. Не стоит недооценивать его маркетинговый потенциал.
Хотя основная цель инструкций для пользователей — поделиться полезной информацией, не пренебрегайте ее маркетинговым потенциалом. Конечно, в руководствах следует избегать прямого маркетинга и информации о продажах, однако хорошая поддержка пользователей приведет к большему количеству покупок.
Ваши онлайн-руководства и документация по продукту могут стать одним из основных инструментов для улучшения поисковых позиций и привлечения потенциальных клиентов для вашего веб-сайта.
Sonat может удовлетворить ваши маркетинговые цели с помощью надежных функций SEO, включая, помимо прочего:
- Интеграция с консолью поиска Google
- Интеграция с консолью поиска Bing
- Мета-тег описания
- Удобный URL-адрес для документов, вариантов документов и тем.
- Использование заголовков
- Интеграция Google Analytics
- CDN, Sonat использует мощную сеть доставки контента, которая сокращает время загрузки контента и приводит к лучшему воздействию на поисковые системы, что приводит к повышению рейтинга в поисковых системах.
- Используйте онлайн-руководство как ценный инструмент для достижения своих маркетинговых целей.
- Улучшите свой рейтинг в поиске и привлекайте потенциальных клиентов для своего веб-сайта, используя руководство пользователя.
Каким будет следующий шаг?
Готовы начать писать руководство? Давайте углубимся и узнаем о его разделах, заголовках, компонентах и содержании. Читайте здесь: Как создать профессиональное руководство пользователя.
Боитесь писать с нуля? Шаблоны творят чудеса. Зарегистрироваться Напишите профессиональное руководство, используя бесплатные шаблоны руководств пользователя .