9 советов по созданию качественной пользовательской документации (с примерами)

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

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

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

Вот где этот пост в блоге входит! я

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

Начните с плана

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

1. Учитывайте свою аудиторию

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

2. Оцените и помните о своей конечной цели

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

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

3. Убедитесь, что вашу пользовательскую документацию легко найти

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

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

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

Краткий, сильный текст

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

4. Напишите описательные заголовки и подзаголовки

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

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

5. Упростите просмотр

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

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

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

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

Глубокая база знаний Hubspot упрощает самообслуживание для их клиентов.

Используйте визуальные эффекты для улучшения понимания

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

7. Используйте аннотированные скриншоты

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

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

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

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

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

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

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

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

9. Покажите примеры и конечные результаты

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

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

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