Как написать руководство по началу работы: руководство для начинающих!

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

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

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

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

Готовы погрузиться? Давай начнем!

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

Что такое руководство по началу работы?

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

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

Цель состоит в том, чтобы привлечь пользователей к их «ага!» момент как можно быстрее.

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

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

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

Начало работы гидов приходят во многих формах:

• Для программного обеспечения это может быть желанным учебником или разделом «Начало работы» в онлайн -справедке.
• Для физического гаджета это может быть маленький сложенный быстрый старт -гид или лист в коробке (часто сопровождаемый полным руководством для последующей ссылки).

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

Цель начального начала

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

Вот несколько основных преимуществ и целей руководства по началу работы:

1. Руководство пользователей через начальную настройку

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

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

2. Снижение бремени поддержки

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

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

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

3. Установка уверенности и доверия

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

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

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

4. сокращение кривой обучения

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

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

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

Результат: пользователи останавливаются дольше, а не избавляются от разочарования.

5. Стандартизация на адаптацию

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

Это ваш шанс поставить свою лучшую ногу вперед с каждым пользователем.

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

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

Цель руководства по началу работы - расширить возможности пользователя . Это должно сказать: «Мы знаем, что вы новичок. Вот как именно начать следовать с этим продуктом».

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

Что включить в руководство по началу работы

Итак, что входит в отличный проводник?

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

1. Краткий обзор или добро пожаловать

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

Установить ожидания заранее. Например, предложение или два могут объяснить: «Это руководство поможет вам установить приложение и отправить ваше первое сообщение менее чем за 5 минут».

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

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

2. Пошаговые инструкции для начальных задач

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

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

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

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

Например: «1. Загрузите приложение : посетите example.com/download и нажмите« Установить ». 2. Создайте свою учетную запись : откройте приложение и заполните форму регистрации…» и так далее.

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

3. Скриншоты или визуальные средства

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

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

Например, если шаг 3 - «Нажмите значок« Настройки », покажите скриншот с знаком настройки, обведенным или выделенным.

4. Основные моменты ключевой функции или следующие шаги

Как только базовая установка будет сделана, руководство по началу работы часто кратко указывает на «что дальше» .

Это может быть короткий раздел, такой как «Explore Next» или «Ключевые функции, чтобы попробовать» .

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

5. Ссылки на дальнейшие ресурсы и поддержку

Хорошее руководство по началу работы распознает свою область, охватывает основы, но у некоторых пользователей будет больше вопросов.

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

Это может быть последний абзац или вставка: «Нужна более подробная информация? См. Руководство пользователя для расширенной настройки и устранения неполадок». или «Посетите нашу базу знаний для подробных статей по каждой функции». Включите ссылки на свой сайт документации, часто задаваемые вопросы, видеоуроки, форумы сообщества - какие бы у вас каналы поддержки у вас.

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

Цель состоит в том, чтобы заверить пользователей в том, что, если что -то не будет рассмотрено в кратком руководстве, есть где -нибудь, чтобы найти ответ.

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

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

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

Основная идея состоит в том, чтобы сосредоточиться на потребностях новичка .

Как говорит технический писатель:

Не думайте, что пользователь уже что -то знает - познакомьтесь с ним на их уровне.

Наконец, форматирование может иметь большое значение .

• Используйте четкие заголовки для каждой части руководства (чтобы пользователи могли легко просмотреть или вернуться в раздел).
• Пулевые точки и пронумерованные шаги улучшают сканируемость по сравнению с длинными абзацами.
• В цифровых руководствах вы можете даже разбить контент на вкладки или складные разделы для каждого шага.
• Гид должен быть легко читать с первого взгляда - дружелюбный и не подавляющий.
• Многие успешные гиды даже включают флажки по каждому шагу или контрольный список в конце, поэтому пользователи чувствуют чувство выполнения по мере их продвижения.

Чем легче на глазах и мозге; Более вероятно, что пользователи будут выполнять.

Шаблон начала работы (пример обстановки)

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

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

Этот шаблон преднамеренно прост. В действительности вы можете объединить или опустить определенные разделы на основе контекста.

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

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

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

Нужна платформа для размещения и организации всех этих руководств?

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

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

Начните с героической базой знаний

Советы по написанию гида

Написание руководства по началу работы - это отчасти искусство и часть науки.

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

Вот несколько лучших советов, которые следует иметь в виду при написании вашего гида:

1. Используйте простой, без жаргонов язык

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

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

Простота - это ключ.

Например, не говорите «Инициализировать параметры конфигурации»; Скажите «Установите свои основные настройки». Ясные, повседневные слова, где это возможно.

Если вы должны включить технический термин (скажем, ваш продукт является API, и вам необходимо упомянуть «ключ API»), предоставьте краткое объяснение или аналогию.

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

Руководство не место, где можно продемонстрировать словарный запас; Это об общении . Тон должен быть дружелюбным и обнадеживающим, как полезный коллега, направляющий пользователя.

2. Будьте прямыми и ориентированными на действие

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

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

Кроме того, сохраняйте предложения короткими и сфокусированными . Длинные, извилистые предложения могут потерять новичка на полпути. Старайтесь к одной идее на предложение или даже используйте фрагменты для инструкций, где это необходимо («Выберите File> Import. Выберите файл данных. Нажмите Open». - Это нормально, если это не полное формальное предложение в этих контекстах).

Старайтесь к чтению Flesch около 80 , написав примерно на уровне чтения 6-го класса, что отлично подходит для широкой доступности.

Это часто означает более короткие предложения и общие слова.

Не волнуйтесь, ваш гид не будет звучать «ошеломленным», это звучит ясно .

Ясность - это профессиональная добродетель!

3. Держите логический поток

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

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

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

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

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

Это не только помогает пользователям, но и улучшает SEO, поскольку поисковые системы могут лучше иерархии контента и ключевых слов.

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

Если вам нужно слишком много объяснить заранее, подумайте, принадлежит ли это отдельному «концепциям», а не в QuickStart.

4. Покажите, не просто говорите

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

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

Визуальные ученики будут вам благодарны.

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

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

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

Если вы документируете физический продукт, четкие чертежи линии или фотографии каждого шага (например, показывая, как вставить SIM -карту в телефон) очень полезны.

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

5. Имейте в виду точку зрения пользователя

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

Обратиться к ним.

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

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

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

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

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

Если многие впервые пользователи спрашивают: «Как мне сохранить свой прогресс?» Затем активно включите это в руководство в соответствующем месте.

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

6. Сохраняйте тонус и человеческий

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

Фразы вроде «Ты все готово!» Или «Давайте сделаем x Далее» заставит пользователя почувствовать себя руководством человека, а не робота.

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

Небольшое легкомыслие может уменьшить беспокойство пользователей.

Однако не переусердствуйте и не отвлекайте от реальных инструкций. Профессиональный, но теплый - хороший баланс.

7. Подчеркните ключевые моменты (но не перегружайте)

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

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

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

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

Например, желтый «наконечник»: коробка может поделиться ярлыком или альтернативным методом, в то время как красная коробка «️ Примечание:» может предупредить об общих ошибках ( «Не отключайте устройство во время обновления». ).

Тем не менее, держите их как минимум в быстром старте - слишком много боковых нот могут ошеломлять.

8. Проверьте руководство с реальными пользователями

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

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

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

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

Если личные тестирование невозможно, даже просто наблюдать за запросами поддержки от новых клиентов может осветить пробелы.

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

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

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

9. Держите его коротким и сосредоточенным

Стоит повторить - краткость является ключом для быстрого начала.

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

Если ваш гид работает долго, скажем, больше, чем несколько страниц или экранов, проверяйте его и спросите: «Действительно ли необходима эта деталь для начала работы, или она может быть перенесена в более поздний раздел документов?»

Обрезать ненужный жир . Одним из рекомендаций от экспертов по документации является правило 1/10, которое мы упомянули: «Быстрый старт должен содержать только около 10% информации полного руководства». Это не точная наука, но она усиливает идею, что это не место для исчерпывающей детали.

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

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

В документации, как и в дизайне пользовательского интерфейса, меньше - больше для адаптации .

Следуя этим советам по написанию, вы создадите руководство, которое не только информативно, но и привлекательно .

Примеры начала работы

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

Эти примеры охватывают цифровое программное обеспечение, а также физические руководства по продукту:

1. Страница с началом работы

Upwork, фриланс платформа, имеет отличное руководство по началу работы для новичков.

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

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

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

Таким образом, это стимулирует вовлечение пользователей (полностью настроенный профиль фрилансера) и уменьшает путаницу.

2. Google Docs Quick Start Guide

В случае Google Docs, справочная статья «Как использовать документы Google», по сути, функционирует как руководство быстрого начала.

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

Руководство очень шаг за шагом. Это начинается с краткого описания того, что такое Google Docs (онлайн -процессор текста и т. Д.), Затем быстро движется в «шаги для начала», например, создание нового документа, обмен его и т. Д.

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

Язык прост и не предполагает никаких предварительных знаний о Google Drive или документах. Разбивая его на устройство, он немедленно обращается к контексту пользователя. Мобильный пользователь не перегружен инструкциями настольных компьютеров и наоборот.

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

3. Home Help Center Slack's Home Home

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

В этом разделе «Начало работы» для Slack есть статьи, которые направляют новых пользователей через основы.

Один из руководств по началу работы Slack буквально прыгает прямо, чтобы объяснить интерфейс - чтобы новые пользователи могли познакомиться с терминологией и макетом.

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

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

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

Эти примеры учат нас нескольким вещам:

• Пользователь для аудитории и контекста. Тон, уровень детализации и форматирование всех соответствует контексту пользователя. Например, разработчики получают более технический тон, общие пользователи получают больше визуальных рук.
• Оставайтесь кратким и ориентированным на задачи: все руководства сосредоточены на включении первых нескольких задач, не объясняя все сразу. Они действуют в качестве запуска.
• Используйте визуально: от аннотированных скриншотов Slack до значков платформы Google до аппаратных иллюстраций, визуальные эффекты используются везде, где они могут заменить или подкреплять текст.
• При необходимости предоставьте несколько форматов: предлагая как онлайн, так и PDF -версию (Microsoft) или разделение быстрого запуска против полного ручного (GoPro), гарантирует, что пользователи могут выбрать, как они потребляют информацию. Руководство по быстрому началу PDF особенно полезно для печати или автономного доступа - рассмотрите возможность предоставления одного, если ваши пользователи могут это оценить.
• Интегрируйте с более крупным набором документации: руководства по началу работы часто связаны или расположены вместе с более полными ресурсами. Они не существуют в изоляции.

Руководство по быстрому началу (PDF) против полного начала работы

Вам может быть интересно различие между «руководством быстрого начала» и полным «руководством по началу работы» - разве это не то же самое?

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

Давайте проясним различия и сходства, особенно в том, что они связаны с форматом (например, PDF) и глубиной содержания:

Последние мысли

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

Это мост между любопытным новым пользователем и удовлетворенным, уверенным клиентом.

Когда все сделано правильно, ваш гид тихо исполнит чудеса на заднем плане:

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

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

• У него есть четкое начало, в середине, конец? (Обзор → Шаги → следующая/поддержка)
• Это как можно меньше, но не короче? (Разрежьте пух, сохраняйте необходимое руководство)
• Инструкции однозначны и удобны для новичка? (Тест, если это возможно)
• Вы включили полезные визуальные эффекты? (И они хорошо маркированы/расположены?)
• Тон дружелюбен и уверен? (Разговорная, не снисходительно или слишком
• Вы предоставляли проспекты для помощи, если руководства недостаточно? (Ссылки на документы, поддержка)
• Доступно ли это и легко читать? (Хорошее форматирование, простой язык, высокий показатель читаемости)
• Вы интегрировали его в свою общую документацию или поток адаптации? (Пользователи могут найти это легко)

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

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