Руководства пользователя являются важной частью предоставления цифровых услуг. Цифровые клиенты ожидают доступа к самообслуживанию, требуя немедленного доступа к информации. Ознакомительная беседа по телефону уже не подходит, приходится тратить часы на объяснение вещей, которые лучше проиллюстрировать в руководствах по документации для пользователей.
Мы в Docsie выступаем за то, чтобы все предприятия создавали библиотеку информативных руководств для клиентов. Это обеспечит самообслуживание, снизит нагрузку на службу поддержки и предоставит круглосуточный доступ в режиме реального времени к информации, необходимой вашим клиентам, чтобы пользоваться и работать с вашим продуктом или услугой.
10 лучших советов по созданию руководств пользователя и документации в Docsie
Прежде чем мы начнем, есть ли у вас способ хранить, писать и размещать документацию?
Перейдите на страницу Docsie Onboarding для ориентированного на клиента сотрудничества, широкого внедрения, адаптированных переводов и мощной публикации под рукой.
Теперь, когда вы вступили в клуб, давайте перейдем к нашим 10 лучшим советам!
1 - Обогатите свои руководства пользователя мультимедиа
Текст, слова, буквы - мы используем их каждый день. К сожалению, написанное слово не может сравниться с правдивостью видео или вдохновением изображений.
При создании руководств по пользовательской документации читайте ее с точки зрения пользователя. Может ли этот раздел быть лучше объяснен в GIF, встроенном видео или аннотированном изображении? Если да, добавьте его!
В Docsie можно добавлять изображения, встраивать видео и интегрировать содержимое iFrame. Попробуйте!
2 - Создайте приказ, только не джедайский!
Пошаговые инструкции - это столп кулинарных книг! Следуя рецепту, смешиваете ли вы яйца с мукой? Это то, что вы должны сделать, и вы знаете это, потому что следуете шагам!
Шутки в сторону, убедитесь, что вы просмотрели все руководства пользователя с пошаговыми инструкциями. Если вы будете следовать этим шагам, получите ли вы желаемый результат? Неточные инструкции, не позволяющие достичь желаемого результата, являются огромным тревожным сигналом для покупателей. С другой стороны, точные инструкции вызывают доверие и обеспечивают ценность для клиентов и бизнеса за счет обмена информацией.
Создайте порядок с помощью нумерованных списков в Docsie или с помощью Docsie Book Articles для сегментации документации.
3 - Ориентируйтесь на все уровни чтения
Предполагаете ли вы, что клиенты будут знать свой JavaScript по вашим советам? Использование жаргона и сложной терминологии обычно рекомендуется в контексте технических руководств пользователя. Однако для неспециалистов чем проще язык - тем лучше!
Большинство читателей просто хотят знать, как сделать то или иное действие, и повторить его. Один из подходов заключается в том, чтобы изложить сложную, высокоуровневую концепцию на бумаге, а затем повторить ее в упрощенной версии для непрофессионалов. Это позволяет одновременно удовлетворить потребности технических пользователей и непрофессионалов, чернить две страницы одной ручкой.
"Искусственный интеллект включает в себя алгоритмическую эмуляцию человеческого интеллекта в погоне за производительностью; искусственный интеллект нацелен на выполнение работы путем подбора человеческого интеллекта с помощью компьютерного кода". - Они оба означают одно и то же, но нацелены на разную аудиторию.
Используйте Docsie для создания полок для неспециалистов и полок для технических пользователей. Таким образом, у вас будут Книги для обеих аудиторий, а полный хостинг будет доступен через портал Docsie.
![Сложный код, упрощенный для простых пользователей на примере Docsie] (https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_cnLx3DDYwihXopx74/boo_dqsfhc7ObadQ3xWmV/411ea34c-096b-3bf2-fde0-2f8fdaddd55aLaypersonSimplificationforDocsie.png)
4 - Используйте шаблоны и перестаньте засиживаться допоздна!
Вы переписываете каждое руководство пользователя с нуля? Вместо этого вам следует создать шаблоны с базовой структурой и фирменным посланием и строить работу на основе этого контента.
Написание с нуля требует времени, усилий и чревато несогласованностью, если несколько авторов работают в рамках одного проекта. Шаблоны - это отличный способ сэкономить время при написании текста и обеспечить большую согласованность между страницами. Доверие строится на последовательных сообщениях и создании ценностей, чему способствуют шаблоны.
Нажмите ...Еще и выберите Шаблоны в Docsie. Здесь вы можете хранить шаблоны и начинать новые Книги, используя шаблон в качестве источника!
5 - Пишите быстро, итерируйте часто
В Agile-разработке программного обеспечения, мантра гласит: "Проваливаться быстро и итерировать часто". Применяя это к руководствам по пользовательской документации, ваши сотрудники должны стремиться писать быстро и часто повторяться.
Это не означает жертвовать качеством ради скорости. Напротив, это позволяет получать отзывы и ответы клиентов с меньшими первоначальными усилиями. Эта обратная связь может быть использована в дальнейших итерациях руководства по пользовательской документации и поможет компании стать более ориентированной на клиента.
Docsie Vocally проясняет отзывы читателей, с оценками и записями экрана, чтобы точно определить содержание, которое они прочитали. Попробуйте его, если вы пишете быстро и часто итерируете!
6 - Вложенные знания с внутренними обратными ссылками
Связана ли документация вашего руководства пользователя обратными ссылками с другими страницами? Добавляя ссылки на соответствующие разделы документации, вы помогаете читателям конкретизировать и понять ваш продукт или услугу на концептуальном уровне.
Когда вы ссылаетесь на конкретную функцию или особенность, всегда добавляйте ссылку. Дайте читателю возможность быстро получить доступ к этой информации, а не заставляйте его самостоятельно искать и загружать страницу. Говорите о входе в аккаунт? Добавьте URL-адрес входа в систему к тексту "войдите в свой аккаунт" на вашей странице и на каждой другой странице. Сделайте вашу документацию удобной и навигационной в основном тексте, а не бесконечной библиотекой, которую нужно пролистывать.
Docsie позволяет авторам руководств пользователя создавать внутренние обратные ссылки. Просто выделите текст и нажмите кнопку 🖇️ на панели инструментов редактора Docsie. Кроме того, вы можете сделать ссылки независимыми от языка и версии с помощью относительных объектных ссылок.
7 - Смахнуть паутину и обновить старый контент
Есть ли у вас старые руководства пользователя и документация, которые можно увидеть в Интернете? Если у вас есть документация версии 1.2, опубликованная в то время, когда ваш продукт находится на версии 1.3, ваша документация больше не актуальна. Вместо того чтобы публиковать новую документацию для каждой версии, используйте Docsie Versioning.
Docsie Versioning позволяет пользователям получить доступ к историческим и настоящим версиям документации. По мере выпуска новых версий, старые версии архивируются для резервирования и доступны из выпадающего меню. Все это находится на одной веб-странице, что облегчает пользователям просмотр и поиск нужной информации.
Аналогичным образом, если ваше руководство "Лучшие советы" за 2021 год все еще публикуется в 2022 году, обновите его! Измените название, обновите все цитаты и источники с помощью обновленных исследований и дважды проверьте, что информация по-прежнему актуальна. Смахните паутину и поддерживайте вечнозеленые темы; контент всегда можно перепрофилировать.
![Выбор версии для поиска старого контента в Docsie] (https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_OaCUumTVGz3CQ2ha2/boo_dqsfhc7ObadQ3xWmV/4edbd225-b61b-0921-4f63-e55b3052ed28DocsieVersionsPickerMenu.png)
8 - Миниатюризируйте задачи, выполняйте их частями
Когда вы пишете, вы пишете всю страницу за один раз с нулевым предварительным планированием? В некоторой степени это сводится к личным предпочтениям писателей. Однако миниатюризация задач позволяет завершить работу быстрее и с большей концентрацией.
Создайте простую структуру с тегами H1 и H2 и кратким описанием каждого раздела. Используйте ее при написании текста и работайте над отдельными разделами, а не над всей страницей. В писательском деле это называется наброском. Набросок дает возможность для обратной связи с редакторами до начала работы и служит направляющей основой в процессе написания.
Создайте новую книгу в Docsie и добавьте несколько основных заголовков и текст для конспекта. Вы также можете добавить Задачи с помощью меню справа, разбив работу на более мелкие части, поскольку над контентом работают несколько членов команды. История версий означает, что вы можете вернуться назад, если автор добавит менее качественный контент - идеальный вариант для быстрого написания и частых итераций!
9 - Оглавление для более содержательных читателей
В сложной и разнообразной документации руководства пользователя стена текста может отпугивать читателей. Эту проблему можно решить с помощью всеобъемлющего оглавления. Обычно используемое в энциклопедиях, оно помогает пользователям определить и перейти к нужной информации, одновременно обеспечивая структуру среды портала знаний.
Статьи, полки и рабочие пространства Docsie работают над созданием оглавления. Оно будет автоматически отображаться в левой части портала знаний, обеспечивая простой способ навигации по базе знаний. С помощью этого совета Docsie сделает это за вас!
10 - Освойте свой предмет
Является ли ваш писатель экспертом в данной области? Аналогично, изобретателен ли ваш писатель и умеет ли он исследовать темы, с которыми он может быть незнаком? В конечном итоге, несмотря на все наши советы, качество ваших руководств по пользовательской документации зависит от писателя.
Чем лучше они понимают ваш продукт, тем точнее будет их работа. Предоставьте писателям возможность тестировать и ломать ваш продукт, поскольку пользователи могут столкнуться с подобными проблемами. Еще лучше провести писателя через демонстрацию продукта вместе с отделом продаж и дать ему практический опыт работы с конвейером продаж и содержащимися в нем сообщениями. Это опять же повышает согласованность и превращает писателей в пользователей. Не все писатели становятся пользователями, но все пользователи могут стать хорошими писателями благодаря практическим знаниям.
Примените эти советы на практике в Docsie!
Спасибо, что прочитали наши 10 лучших советов по улучшению руководств пользователя. Мы приглашаем вас применить эти советы в ваших документах Docsie!
Docsie - это платформа сквозного управления документацией, которую компании используют для создания веб-частотных вопросов, документации по продуктам, руководств пользователя, справочных документов и руководств пользователя. Платформа обеспечивает ориентированное на клиента сотрудничество, широкие возможности встраивания, индивидуальные переводы и мощную публикацию.
Сделайте свой шаг onboarding with Docsie сегодня, и доставьте документационный восторг своим клиентам!