Как сделать отличный краткий справочник

Что такое краткое руководство

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

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

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

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

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

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

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

Почему это важно?

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

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

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

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

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

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

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

К счастью, Snagit упрощает создание краткого справочного руководства.

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

Является ли краткое руководство кратким справочным руководством?

Быстрый ответ: Да!

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

Есть смысл?

Как сделать краткое руководство за шесть простых шагов

И, если у вас нет нужных инструментов, здесь все может стать очень сложно. Например, попытка поместить все в документ Microsoft Word может занять много времени.

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

Но это не должно быть так.

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

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

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

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

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

Шаг 1. Сделайте скриншоты

Сначала сделайте все необходимые скриншоты и сделайте любые аннотации (стрелки, текст и т. д.), которые вы хотите включить в графику.

Шаг 2. Создайте свой шаблон

Затем в редакторе Snagit выберите «Создать» > «Создать изображение из шаблона».

Шаг 3. Выберите шаблон

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

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

Шаг 4. Добавьте изображения

Из панели в нижней части редактора Snagit (панель «Недавние изображения») перетащите снимки экрана на заполнители в шаблоне.

Шаг 5. Измените размер изображений

Измените размер или иным образом откорректируйте скриншоты по мере необходимости.

Шаг 6. Добавьте письменный контент

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

И вы сделали!

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

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

Распространенные типы кратких справочников

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

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

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

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

Все это (и НАМНОГО больше) можно выполнить с помощью краткого справочного руководства.

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

1. Инструкция по началу работы
   Помогите своим пользователям быстро начать работу с вашим продуктом.
2. Руководства по основным или базовым задачам
   Похоже на краткое руководство, но предлагает обзор того, как использовать самые основные или основные функции вашего продукта или услуги.
3. Руководство по дополнительным функциям
   Когда ваши пользователи будут готовы перейти на новый уровень, используйте краткое справочное руководство, чтобы познакомить их с другими функциями или функциями.
4. Руководство по изменениям продукта
   Ваше программное обеспечение недавно обновлялось? Используйте краткое руководство, чтобы познакомить пользователей с изменениями.
5. Пошаговая инструкция
   Есть процесс, который нужно объяснить? Покажи это!
6. Руководство пользователя для продуктов с ограниченными функциями или функциями
   Если для вашего продукта не требуется большое руководство, краткое справочное руководство может быть всей необходимой документацией.

Важные элементы для создания отличного краткого справочника или краткого руководства

Знайте свою аудиторию и ее потребности

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

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

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

Простота — это ключ

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

Используйте визуальные эффекты

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

Включайте только важную информацию

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

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

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

Используйте простой и понятный макет

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

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

Визуальный контент

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

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

Фактически, наше исследование «Ценность визуальных элементов» показало, что люди лучше учатся с изображениями и текстом, чем с одним только текстом.

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

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

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

У наших друзей из Venngage есть дополнительная информация о важности визуального контента.

Краткое справочное руководство, что можно и чего нельзя делать

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

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

Делать

1. Держите его как можно короче. Лучше всего одну-две страницы.
2. Используйте визуальные эффекты, такие как аннотированные скриншоты, значки, изображения продукта или UX и т. д.
3. Используйте разумный, понятный макет с четкими заголовками и подзаголовками по мере необходимости.
4. Знайте свою аудиторию и то, что ей нужно.
5. Заставь его стоять на своем. Пользователям не нужно заглядывать в ваше руководство, чтобы понять ваш краткий справочник.

Не

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

Начните создавать потрясающие краткие руководства с помощью Snagit 2020

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

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

Примечание. Эта статья была первоначально опубликована в апреле 2020 г., но в нее добавлена ​​новая информация.