Руководства пользователя — важная часть цифровых услуг¶

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

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

10 главных советов по созданию руководств и документации в Docsie

Для начала: есть ли у вас система для хранения, написания и размещения документации?

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

Теперь, когда вы присоединились к нам, перейдем к нашим 10 главным советам!

1 — Обогащайте руководства пользователя медиаконтентом

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

При создании руководств посмотрите на них глазами пользователя. Можно ли лучше объяснить этот раздел с помощью GIF, видео или изображения с аннотациями? Если да — добавьте их!

В Docsie вы можете добавлять изображения, встраивать видео и интегрировать содержимое через iFrame. Попробуйте!

2 — Создавайте последовательность (и речь не о джедаях!)

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

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

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

3 — Учитывайте разные уровни подготовки читателей

Считаете ли вы, что клиенты отличат JavaScript от ваших советов? Использование профессионального жаргона уместно в технических руководствах. Для обычных пользователей, однако, чем проще язык — тем лучше!

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

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

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

4 — Используйте шаблоны и не засиживайтесь допоздна!

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

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

Нажмите «...Еще» и выберите «Шаблоны» в Docsie. Здесь вы можете хранить шаблоны и создавать новые книги, используя шаблон как основу!

5 — Пишите быстро, улучшайте часто

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

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

Docsie Vocally собирает отзывы читателей, предоставляя оценки и записи экрана, чтобы точно определить, какой контент они читали. Попробуйте, пока пишете быстро и часто улучшаете!

6 — Вложенные знания с внутренними ссылками

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

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

Docsie позволяет создавать внутренние ссылки. Просто выделите текст и нажмите кнопку 🖇️ на панели инструментов редактора Docsie. Кроме того, вы можете сделать ссылки независимыми от языка и версии с помощью относительных объектных ссылок.

7 — Сметите пыль и обновите устаревший контент

Есть ли у вас устаревшие руководства в открытом доступе? Если у вас опубликована документация для версии 1.2, а ваш продукт уже на версии 1.3, ваша документация больше не актуальна. Вместо публикации новой документации для каждой версии используйте систему версионирования Docsie.

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

Аналогично, если ваш гид по советам за 2021 год всё ещё опубликован в 2022, обновите его! Измените название, обновите цитаты и источники актуальными исследованиями и проверьте, что информация по-прежнему актуальна. Сметите пыль и поддерживайте контент вечнозеленым — его всегда можно переработать.

8 — Разбивайте задачи на мелкие части, выполняйте пакетами

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

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

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

9 — Оглавление для более удобного чтения контента

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

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

10 — Овладейте своей темой

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

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

Применяйте эти советы на практике в Docsie!

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

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

Сделайте шаг вперед, присоединившись к Docsie уже сегодня, и подарите вашим клиентам отличную документацию!