Что собой представляет инструкция по документированию управленческой деятельности

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

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

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

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

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

Легко создать руководство пользователя (Бесплатный шаблон)

Шаблоны Snagit-это самый быстрый способ создания руководств пользователя. Создавайте пошаговые руководства с простым и профессиональным видом.

Скачать

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

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

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

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

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

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

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

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

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

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

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

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

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

Это может порадовать ваших клиентов

Документация пользователя проста, не так ли? Я имею в виду, просто напишите что-нибудь о том. Как использовать ваш продукт, и вы можете идти!

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Простой язык

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

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

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

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

Но именно там вы можете нарваться на серьезные неприятности.

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

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

Простота

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

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

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

Лучшая документация пользователя прекрасно иллюстрирует пословицу: “показывай, не рассказывай.”

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

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

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

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

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

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

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

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

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

Скорее всего, вы уже сталкивались с упрощенной графикой и даже не осознавали этого.

Как этот из G Suite Learning Center:

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

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

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

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

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

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

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

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

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

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

Содержание

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

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

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

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

Специальные возможности

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Шаг 1: План

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

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

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

Прежде чем вы сделаете документацию, вот несколько вещей, которые следует рассмотреть:

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

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

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

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

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

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

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

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

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

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

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

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

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

PDF: Должны вы или не должны?

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

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

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

После того, как вы ответили на все вопросы и приняли все решения, описанные выше. Пришло время создать свою пользовательскую документацию. Я не собираюсь рассказывать вам. Как ИМЕННО создать документацию для вашего конкретного продукта. Но есть некоторые ключевые вещи. Которые следует иметь в виду.

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

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

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

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

Шаг 4: Держите свою документацию в актуальном состоянии

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

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

Краткие сведения

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

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

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

Легко создать руководство пользователя (Бесплатный шаблон)

Шаблоны Snagit-это самый быстрый способ создания руководств пользователя. Создавайте пошаговые руководства с простым и профессиональным видом.

Скачать

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

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

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


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

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


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

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


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

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

Примечание: Этот пост был первоначально опубликован в августе 2019 года. Но был обновлен в сентябре 2020 года для ясности и включения новой информации.