Подробное руководство по продукту

7 нюансов, которые важно учитывать в инструкциях, но этого никто не делает

Я Андрей Горелов, главред IT-компании Prodamus. В этой статье расскажу, как мы быстро делаем инструкции о наших продуктах и получаем такие отзывы от сотрудников техподдержки:

Представьте, что ваши инструкции читают люди, которые не владеют ПК

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

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

Делайте скриншоты на каждый шаг инструкции

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

Область, где нужно что-то нажать или ввести, затемняйте, чтобы пользователь быстро сообразил, что и где нужно сделать:

Пишите текст так, чтобы вас поняла ваша бабушка

Это даже не инфостиль, а бабкостиль (да, простят меня пенсионеры, я заранее извиняюсь) где важно подробно и последовательно объяснять, что нужно делать. Инструкция должна быть похожа примерно на это: «Ба, вот сюда нажми, потом появится снизу слева красная иконка, вот туда жми, затем появится меню, вот там введи то-то и то-то».

❌ Ой, милок, я не поняла ничего

Чтобы выйти из платёжной страницы, нажмите на кнопку внизу. Затем нажмите на «Сохранить», потом сформируйте ссылку на тестирование оплаты.

✅ Спасибо тебе, дай бог тебе здоровья и невесту красивую

Чтобы выйти с платёжной страницы, нажмите внизу на иконку с открытым замком.Затем нажмите на «Сохранить», потом сформируйте ссылку на тестирование оплаты. Для этого нажмите «Создать ссылку» в левом нижнем углу экрана.

Делайте скринкасты для мини-инструкций

Если в вашей инструкции появилось несколько вариантов дополнительных настроек, которые можно сделать 2-3 кликами, лучше их продемонстрировать скринкастом, чтобы не делать ваш мануал в 100500 экранов.

На повторяющиеся пункты инструкции делайте активные ссылки

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

Дублируйте текстовую инструкцию видеоинструкцией

Снимать видеоинструкцию просто. Зайдите в Zoom или Skype, включите запись звонка и на демонстрации экрана покажите, что и где нужно нажать, залейте её на YouTube или соцсети, потом вставьте в ваш хелп. Можно добавить на монтаже логотип и обложку видео, ил идаже музыку на фон без авторских прав.

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

Коротко: как быстро делать понятные инструкции для пользователей

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

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

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

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

• Пользователи бывают разные. То есть они могут отличаться как по возрасту, отрасли и опыту, так и по количеству мотивации. Мотивация особенно касается b2b сервисов. Многие пользователи попадают в продукты, потому что «Начальник сказал».

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

Документация помогает пользователю решить проблему или помочь разобраться с особенностями и фишками продукта. В любой документации люблю раздел Tips&Tricks.

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

Пользовательская документация — это не юридические документы. У них другие цели.

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

Что еще можно отнести к пользовательской документации

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

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

• Ответы на часто задаваемые вопросы (FAQ).

• Руководство пользователя. Это самый жирный кусок из всей пользовательской документации. Здесь описывается весь интерфейс, только текстом.

• Краткое руководство пользователя. Короткая презентация или документ для быстрого начала. Описывает базовые функции, возможности и советы для начала. Главное отличие от полного руководства — быстрее читаются, дают базовое представление о продукте и особенно помогают при внедрении b2b продуктов.

• Описание отдельных фишек (Tips&Tricks). Чаще всего их делают в формате видеоуроков, но можно наткнуться и на текстовые.

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

• Видеоуроки. Считаю их частью пользовательской документации, но это скорее вкусовщина, чем правило.

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

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

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

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

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

Красоты B2B рынка

Прошлый продукт, над которым мы с командой работали, умел и в облако, и в on-premise.
С облаком все понятно. Динамическая документация на сайте или в другом сервисе. Документация для корпоративных заказчиков имеет определенные особенности. 

Особенность #1: Корпорации любят печатную документацию. Очень сильно.
Мой знакомый сейлз любит рассказывать истории про это. 

Резюме его историй:

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

Поэтому чем толще кипа бумаги — тем лучше.

Особенность #2: Нужно отдавать дополнительные пакеты документов.
В дополнительные пакеты документов входит: документация по установке вашего ПО и документацию по его администрированию, а может ещё что-то, если попросят.

Особенность #3: Документацию, которую вы отдаете корпоративному заказчику, нужно будет поддерживать отдельно. 
Реальность работы с большими корпоративными заказчиками в том, что ваш продукт требует доработки для решения их задач. Всегда есть какие-то нюансы и дополнения. Поэтому отдавать им облачную документацию, чаще всего, не получится.

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

Где делать?

Много думал, долго смотрел. Переделывал наш гайд раз пять.

Когда искал, ставил для себя следующие задачи:

• Документацию можно сделать динамической. То есть возможность грузить видео, гифки, делать кросс-ссылки.

• Поддерживается базовое форматирование: заголовки, жирный, курсив, code, code block.

• Возможность экспортировать в .pdf.

Небольшой совет

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

• Есть возможность выложить документацию на свой домен.

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

Какие вариант рассматривал:

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

• Google Docs.
  Стоимость: Free
  Плюсы: очень удобно работать с вёрсткой документа; привычный, при этом более простой интерфейс, относительно MS Docs; есть синхронизация с облаком; есть экспорт в .pdf.
  Минусы: очень тяжело работать с визуальной частью — скринами; отношу в категорию не динамичных, так как выложить ссылочку на сайт на Google Doc конечно можно, особенно учитывая их последние апдейты, но это выглядит как-то не серьезно. 

• Notion.
  Стоимость: можно Free, если работает один человек, а так от 8-10$ за человека.
  Плюсы: очень удобно делать динамическую документацию, которую не стыдно выложить на сайт, по моим ощущениям; удобно работать в паре, есть все необходимое; можно вставить любое медиа, хоть ссылку, хоть видео, хоть схему из miro.
  Минусы: не самый широкий спектр инструментов для работы с версткой; если неправильно сверстать, скопировать кусочек текста в другое место бывает накладно; не для всех пользователей привычная навигация по страницам.

• Другие инструменты для wiki. Я смотрел на несколько вариантов wiki.js, Stonly 2, Dropbox Paper, Outline. 

  Смотрел давно, поэтому ничего вразумительно сказать не смогу. Помню, только что из всего выше, зацепил Dropbox и Wiki.js. В процессе написания этой статьи наткнулся ещё на один интересный сервис — GitBook. Он удовлетворяет всем моим запросам к подобным инструментам, но прошел мимо меня когда выбирал. 

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

С чего начать?

Не скажу ничего нового.
Начинать нужно с ответа на вопрос «Зачем мы это будем делать?». Мы начинали писать первую версию как раз для корпоративного заказчика. Но эта итерация была небольшой. Писали краткий гайд.

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

После того, как поняли зачем, накидайте план, а точнеё оглавление. План подразумевает последовательность, а оглавление позволяет вам писать не последовательно. Я писал непоследовательно. Сначала писал то, что помнил на память, потом все остальное.

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

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

Основные правила

Понятный и простой язык

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

Любой текст должен быть простым и понятным.

Самое главное всегда это помнить.

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

Понятное и аккуратное форматирование

Я люблю типографику и когда все аккуратно. Поэтому случаются приступы гнева, когда документы плохо сверстаны. Считаю это важным, так как эти правила придумали не просто так, а чтобы было удобно для читателя. 

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

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

  Основные кавычки оформляются елочкой «», внутренние кавычки оформляются лапками „“. Например, «Нажмите на вкладку „Контакты“ в левом верхнем углу», забугорные кавычки выглядят так «_».

  

  P.S. Иностранные названия в русском тексте кавычками не выделяются. 

• Тире и дефис.
  Все знают про тире и дефис. Оказалось, что многие не знают про среднее тире.

  Дефис (-) используется для присоединения частиц (что-то), для присоединения префиксов (по-братски), в словосочетаниях и сложносоставных словах (бизнес-ланч).
  Среднее тире (–) применяется в числовом обозначении диапазонов и интервалов: 2011–2022, 11–12 ноября.
  Длинное тире (—) используется для выделения прямой речи, указания маршрутов (Москва — Санкт-Петербург), между подлежащим и сказуемым.

• Оформление списков.
  Существуют два вида списков: нумерованный и маркированный.

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

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

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

  Ещё один важный момент. 

  • Если пункт списка начинается с большой буквы, на конце всегда точка.

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

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

• Оформление дат и чисел.
  Если в тексте присутствуют даты, то лучше писать 15 мая 2021, а не 15.05.2021. Помогите пользователю думать только о важном.

  Если есть числа, то их нужно тоже оформить правильно. Не 2221, а 2 221. Отделяйте тысячные, это очень сильно упрощает восприятие.

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

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

• Буква Ё.
  С этой буквой у меня особые отношения. Исторически моя фамилия пишется через Ё, но из-за передергивания правил русского языка в советском союзе моя фамилия теперь пишется через Е. Поэтому я долгое время принципиально везде писал Е. Годы идут. Мозгов прибавилось. Теперь стараюсь писать Ё везде, где ей место. Так действительно проще воспринимать текст.

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

  Я использовал эмодзи для визуального подчеркивания каких-то кнопок в интерфейсе.
  Например: Нажмите на символ ⚙️ в правом верхнем углу.

  Для поиска символов пользуюсь Glyphy.

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

Если ваш продукт международный

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

Удобная навигация

Нет единого мнения — как правильно. Если самопис, я рекомендую делать вертикальную навигацию слева. Такая часто встречается в технических документациях.

По структуре, на мой взгляд, можно выделить такие блоки:

• Блок общего и важного.

  • Описание вашего решения. Вдруг пользователь попал сначала на ваш гайд, а не на сайт.

  • FAQ.

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

  • Наши обновления.

• Блок «Как начать». Сюда писать общие вещи, которые касаются всего сервиса. Особенно важный блок, если у вас мультиплатформенное решение.

• Блок с руководством пользователя. Если у вас мультиплатформенное решение, то на каждую платформу лучше писать свое руководство. Можно объединять мобильные приложения и ПК версию. Так можно делать если нет глобальной разницы.

  У нас, например, исторически разницы не было. Поэтому iOS и Android лежат на странице «Мобильные приложения». Но сейчас мы начали разделять, поэтому в будущем будет разделение на ОС.

Связность

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

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

Удобный поиск

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

Вот как мы это в Notion решили.

Логичность

Всё, что вы пишите должно быть логичным. 

Порядок элементов в тексте и интерфейсе должен быть одинаковым. Пользователь ломается, когда написано: «Нажмите на вторую вкладку „Контакты“», а вторая вкладка — «Чаты». 
Или когда в интерфейсе элемент называется «Назначить админом», а написано «Назначить администратором». 

Понятная визуалка

Этот пункт я бы хотел разбить на два блока: работа с медиа и работа с Step-by-Step.

Работа с медиа

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

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

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

Очень не люблю стрелочки. Считаю, что лучше выделить место геометрической фигурой и поставить номер шага. Но иногда стрелочки приемлемы, тут вкусовщина.

Из хороших приемов — блюрить лишнюю часть интерфейса или делать выделение лупой важной части.

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

Step-by-step

Step-by-Step — это пошаговое описание всех действий, которые нужно выполнить пользователю, чтобы получить результат.

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

• Делать нумерованные списки. Если есть подпункты, то нумеровать их соответственно и делать сдвиг вправо 1.1, 1.2, 1.2.1 и тд.

• Писать сначала «Что нажать», потом «Где нажать». Исхожу из простой логики — сначала нужно понять «Что искать» и только потом «Где искать».

  Например: «Нажмите на кнопку „Включить“ в правом верхнем углу», а не «В правом верхнем углу нажмите на кнопку „Включить“».

• Вставлять визуальные элементы для кнопок, особенно если они без подписи. Для этой истории приходится немного костылить, если делать это в том же Notion, но в Google Docs это делать проще. Использую стандартные эмодзи и сервис Glyphy.

  Например: Нажмите на символ ⚙️ в правом верхнем углу.

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

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

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

• Все названия кнопок, сущностей, элементов — должны иметь такое же название как в интерфейсе.

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

Поддержка и послесловие

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

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

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

Раз в 3-6 месяцев заходить и перечитывать, лучше если это каждый раз будет делать новый человек. Это нужно делать по трем причинам:

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

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

3. Всегда есть что улучшить. Текст это такой же продукт.

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

p.s. Пользовательская документация с которой все началось. Скажу сразу, там очень много чего можно и нужно улучшить. Бэклог по апдейту документации уже перевалил за 30 задач. Постепенно обновляем.

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

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

Этим и объясняется растущий интерес продакт-менеджеров к такому средству привлечения и удержания клиентов, как онбординг или обучение продукту (product education), в рамках которого одним из наиболее эффективных инструментов являются знакомые всем пошаговые руководства (product walkthroughs) или интерактивные продуктовые туры: благодаря им, наступление «Ага!»-момента у пользователя становится делом более управляемым и прогнозируемым. 

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

Содержание статьи

Что такое product walkthroughs?

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

4 простых шага, чтобы сделать эффективное руководство по продукту

1. Определите показатель ценности
2. Определите препятствия на пути к цели
3. Дизайн
4. Разработка

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

CitizenShipper
Evernote
Ninox

Заключение

Что такое product walkthroughs?

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

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

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

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

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

Почему «одноразовый» онбординг — не выход?

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

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

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

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

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

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

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

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

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

11 простых способов прокачать активацию функций вашего продукта

4 простых шага, чтобы сделать эффективное руководство по продукту

Всего 4 шага отделяют от вас от создания руководства, которое ощутимо выделит вас на фоне конкурентов.

1. Определите показатель ценности

Главная задача пошагового руководства — максимально быстро довести пользователей до «Ага!»-момента: того самого мгновения, когда пользователь видит отдачу от продукта и он начинает казаться ему удачной находкой.

То, что происходит в это время, в конечном счете зависит от самого продукта.

Возьмем, к примеру, Instagram.

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

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

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

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

Метрики активации: реальная мера успеха вашего стартапа

2. Определите препятствия на пути к цели

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

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

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

Среди наиболее распространенных трудностей— следующие:

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

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

7 этапов адаптации пользователей для бизнеса по подписке

3. Дизайн

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

Наиболее эффективные руководства, как правило:

• предельно понятны: в них четко указано, что и как нужно делать, чтобы воспользоваться конкретной функцией — никакой двусмысленности или непонятных рядовому юзеру жаргонизмов;
• лаконичны: пользователи заинтересованы в том, чтобы как можно быстрее получить конкретный результат, ценность, поэтому пошаговые инструкции должны быть емкими (чтобы оставаться понятными), но вместе с тем сохранять краткость;
• интерактивны: пошаговые руководства уже должны быть интерактивными по определению, они требуют от пользователей взаимодействия и выполнения задач. Задачи должны быть содержательными, с числом рекомендаций, соответствующим сложности рассматриваемого шага, привлекательными графически и понятными по смыслу;
• имеют возможность пропуска: не всем пользователям будет удобно проходить пошаговое руководство в тот момент, когда вы им это предложите, а кто-то не будет изучать его в принципе. Возможно, кто-то уже плотно работал с вашим приложением раньше, и он не нуждается в помощи. Те сложности, которые вы определили в своем продукте, для некоторых пользователей таковыми не окажутся;
• дополнительная поддержка: с другой стороны, для некоторых пользователей пошагового руководства может быть недостаточно, и им может потребоваться дополнительная помощь. В рамках руководства этот канал помощь должен быть реализован, например, в виде live-чата.

6 типов UX/UI-шаблонов онбординга: что и когда использовать?

4. Разработка

А теперь о самом сложном.

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

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

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

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

CitizenShipper

CitizenShipper — это маркетплейс услуг доставки, который работает в США и предлагает пользователям различные услуги по отправке и доставке товаров.

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

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

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

Как только новый водитель или подрядчик входит в CitizenShipper, его встречает краткое описание продукта:

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

А ниже — мобильная версия того же гида:

«Мы рады, что вы присоединились к нам! Сейчас мы вам покажем, что и как тут устроено»

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

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

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

Персонализация онбординга как лучшая стратегия гроуз-хакинга

Evernote

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

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

«Добро пожаловать в Evernote! Давайте выясним, как и чем мы вам можем помочь. Это займет меньше минуты»

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

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

«Для каких целей вы собираетесь использовать Evernote: создание заметок, формирование чек-листов, планирование проектов? На каком устройстве вы будете пользоваться решением: настольный компьютер, веб-браузер, смартфон, планшет?» — и т.д.

В процессе создания первого списка руководство поможет вам сориентироваться в

редакторе.

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

Еще один пример, как Evernote демонстрирует различные функции элемента:

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

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

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

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

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

Итак, Evernote хороши в том, что:

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

14 принципов онбординга для вашего сайта или приложения

Ninox

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

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

Добро пожаловать! Привет, я ваш персональный помощник. Всего за несколько шагов я познакомлю вас со всем приложением

И он держит данное слово, поскольку действительно всего за несколько шагов вам удается посмотреть всю главную панель управления продуктом. По завершении этих 5 шагов на экране появится чек-лист адаптации:

Нужно ли повторять, что подобные чек-листы — настоящая находка для пользователя? 

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

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

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

Можно с уверенностью сказать, что пример руководства по продукту Ninox весьма показателен:

• сервис обещает, что обучение не отнимет у пользователя много времени (так и происходит);
• процесс адаптации донельзя прост и ориентирован на скорейшее наступление «Ага!»-момента.

Топ-5 KPI онбординга пользователей

Заключение

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

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

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

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

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

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

Прокачайте свой онбординг!

По материалам: userguiding.com Изображение: freepik.com

Инструкция – справочный документ, где собраны правила эксплуатации товара. Это может быть руководство пользователя бытовой техники, указания к применению лекарственного препарата, статья в разделе FAQ или текст на пачке риса. Продавец обязан предоставить покупателю информацию о товаре согласно статье 10 закона России «О защите прав потребителей».

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

Виды инструкций

По содержанию инструкции бывают:

1. Описательные. Цель описательной инструкции – познакомить покупателя с товаром: рассказать о полезных функциях смартфона, возможностях сервиса, материалах оконного профиля или применении битумной мастики.

Пример:

«Фалевая защелка – часть дверного замка для максимального прилегания полотна к коробке в закрытом положении».

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

Пример:

«Включите стиральную машину с помощью кнопки СТАРТ.

Удерживайте кнопку таймера «5» до появления индикации «3h» на диалоговом окне».

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

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

Еще инструкции разделяются по формату:

• текстовые;
• видеоинструкции;
• скринкастинг – запись действий с экрана компьютера;
• инфографика – подборка иллюстраций для быстрой передачи сути;
• FAQ – справочный раздел сайта для ответов на популярные вопросы.

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

Правила составления текстовых инструкций

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

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

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

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

Структура

Типовая инструкция включает следующие разделы:

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

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

122 статьи по контент-маркетингу: императорская подборка полезностей

Оформление текста

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

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

Примеры:

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

Примеры:

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

Примеры:

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

Примеры:

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

Подберите читаемый шрифт текста. Шрифты с засечками (Times New Roman, Georgia) имеют небольшие черточки по краям линий. Они подходят для объемных печатных документов в 12 размере. Шрифты без засечек (Arial, Verdana) хорошо читаются на электронных документах.

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

Примеры шрифтов:

Иллюстрации

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

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

Как я стала писать для «Текстерры»: история бывшего копирайтера

На чтение 10 мин Просмотров 1.1к. Опубликовано 30.10.2021

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

Что такое описание продукта?

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

Часто в описаниях продуктов упоминаются…

• Технические характеристики и особенности физического продукта
• Стили
• Цвета
• Массы
• Размеры
• Фотографии
• Технические данные
• Преимущества и применение продукта
• Типы материалов, используемых в строительстве
• Байки о товаре и идеальном покупателе
• Как что-то сделано (то есть изготовлено или изготовлено вручную)
• Где что-то производится (или источник в производственной цепочке)
• Информация об устойчивости
• Информация о ценах
• Информация по поставке

Как написать эффективное описание продукта

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

№1. Начните с SEO.

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

• Описание товара: «Фиолетовая кепка с принтом гепарда»
• URL-адрес страницы продукта (например, sampleboutique.com/purple-hat-cheetah-print)
• Альтернативный текст каждого изображения продукта

№ 2. Помните о своей аудитории

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

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

№3. Держите голос вашего бренда последовательным.

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

№ 4. Обратите внимание на конверсию

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

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

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

Три примера описания продукта

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

№1. Одежда Описание товара Пример

Описание этой худи от Le Brow Bar — прекрасный пример того, как нужно писать описания продуктов для одежды.
Базовое описание продукта начинается словами «одежда для дома, в которой вы будете жить», что апеллирует к эмоциям целевой аудитории. После этого он предоставляет полезную информацию о составе предмета. «Смешивайте и сочетайте, чтобы создавать милые и удобные наряды!» завершает описание продукта, которое представляет собой скрытый метод перекрестной продажи большего количества вещей.
Вторичное описание включает в себя более полезную информацию, включая особенности, посадку, состав и уход за одеждой.

№ 2. Пример описания косметического продукта

При продаже в Интернете чего-то сложного для понимания, например парфюма, описание продукта должно сделать тяжелую работу, чтобы совершить продажу. Etiket, бутик косметики класса люкс, демонстрирует, как это сделать, в своем описании продукта для этого парфюма.
«Phi — это насыщенный запах, вдохновленный натуральным экстрактом роз, выращенных в самом сердце роз Афганистана, Нангархаре», — говорится в описании. Он взывает к эмоциям ищущих роскошь покупателей, подчеркивая уникальное происхождение аромата духов.
«Это розовое масло исключительно редкое и высочайшего качества. Вдохновленный этими цветами, растущими на выжженной и суровой земле, Phi — редкое сокровище, гармонирующее противоположные линии, богатое природным сырьем, которое обеспечивает глубину и подлинность», — говорится во вторичном описании.
Далее обсуждается эксклюзивность аромата, а затем подробно описываются ноты аромата, чтобы помочь передать в письменной форме то, что обычно можно понять только через запах:
«Phi открывается пышной фруктовой линией абрикоса. «Полностью натуральный экстракт абрикоса очаровывает и смешивается с линией корицы и оттенками горького миндаля, смягченного эфирным маслом бергамота».

№3. Пример технического описания продукта

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

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

Создайте (и протестируйте) свой собственный шаблон описания продукта

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

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

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

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

• Напишите заголовок, который привлечет внимание вашей целевой аудитории. Держите свои идеи простыми, подчеркивая немедленную выгоду от продукта. Например, если вы продаете футболку для йоги с рисунком, назовите ее «Рубашка Fleck Studio».
• Напишите короткий абзац на основе основных элементов и наиболее часто используемой информации, приведенной выше. Обратитесь к приведенным выше примерам, чтобы получить вдохновение для написания увлекательного описания.
• Предоставьте список характеристик и преимуществ продукта в виде маркера. Предоставьте все необходимые технические данные.
• Добавьте социальное доказательство. Вы можете использовать приложение для отзывов клиентов, чтобы записывать отзывы о продуктах на своем веб-сайте и интегрировать другие со сторонних сайтов, таких как поисковые системы или Facebook.

Какой длины должно быть описание продукта?

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

• Сокращенная форма (50 слов или меньше)
• Стандарт (100 слов)
• Полная форма (250+ слов)

Что описания продуктов могут сделать для компании?

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

Преимущества описаний продуктов

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

Вот преимущества:

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

Как написать эффективное описание продукта?

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

Какой формат лучше всего подходит для описания продукта?

• Конкретное название продукта
• Короткий описательный абзац
• Маркированный список функций и технических деталей
• Социальное доказательство
• Призыв к действию

Заключение

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

Думайте визуально. Улучшите фотографии вашего продукта с графикой. Скопируйте A/B-тест и сделайте эти страницы личными. Посмотрите в Google Search Console, чтобы найти популярные термины и важные слова, чтобы вы могли увеличить SEO-трафик на страницу продукта.

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

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

Статьи по теме

• АНАЛИЗ РАБОТЫ: эффективные методы анализа работы (+процесс и цель)
• БИЗНЕС-ПЛАН: примеры и шаблон для стартапа
• МАРКЕТИНГ ПРОДУКТА: значение, виды, стратегия и примеры
• РЕКЛАМНЫЕ ОБЪЯВЛЕНИЯ ТОВАРОВ: Руководство по передовому опыту
• ПРОДВИЖЕНИЕ ПРОДУКТА: лучшие примеры и идеи продвижения

Рекомендации

• Shopify
• BigCommerce
• WordStream

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

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

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

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

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

1. Предложение идей

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

При разработке концепции нового продукта необходимо учитывать следующие факторы:

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

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

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

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

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

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

2. Определение продукта

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

На этом этапе важно определить следующие аспекты:

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

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

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

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

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

3. Разработка прототипа

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

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

На этапе подготовки прототипа прорабатываются следующие аспекты:

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

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

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

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

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

Попробовать ПО для управления рабочими процессами от Asana

4. Первоначальный дизайн

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

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

В рамках создания исходного дизайна выполняются следующие действия: 

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

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

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

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

5. Утверждение и тестирование

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

Для обеспечения высокого качества продукта выполните следующие действия:

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

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

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

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

6. Коммерциализация

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

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

На этом этапе выполняются следующие работы:

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

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

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

Примеры процесса разработки продукта

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

Пример 1. Как компания Figma расширила функционал своего продукта

• Запущенный в 2012 году продукт Figma стал первым профессиональным инструментом для разработки пользовательских интерфейсов, работающим полностью в браузере. На сегодняшний день компания Figma занимает ведущее положение на рынке веб-приложений для дизайна.

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

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

Пример 2. Как компании Uber удалось занять нишу на рынке

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

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

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

Кто входит в состав группы разработки продуктов?

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

К числу других важных участников процесса относятся:

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

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

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

• Разработчики. Специалисты по разработке помогают разместить продукт на вашем веб-сайте. Чаще всего группа разработчиков работает совместно над созданием нового продукта в зависимости от сложности концепции.

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

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

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

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

Читать о том, в чём разница между менеджером продуктов и менеджером проектов

Расширяйте свой портфель, разрабатывайте новые продукты

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

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

Попробовать Asana для управления продуктами

![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_fnrc6e2hqBPbGE5DG/boo_NbQ7i8LYu6f7q4rnn/13a8cb93-d20f-41ad-1e5e-6e888f610ea7corinne_kutz_tMI2__r5Nfo_unsplash.jpg)

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

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

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

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

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

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

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

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

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

Какова цель документации по продукту?

Когда вы говорите о документации на продукт для технологического продукта или услуги, вы имеете в виду информацию, которая описывает его, и данные, относящиеся к нему.

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

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

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

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

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

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

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

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

Корпоративная документация: [Опросы показывают] (https://www.inc.com/david-finkel/why-policies-and-procedures-manuals-are-dead-and-what-you-should-replace-them-wi.html), что более 8 из 10 компаний из 1000 опрошенных используют формальные политики и руководства по процедурам.

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

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

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

Найти руководителя отдела разработки документации по продукции

![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_PsI4RmXQikpEACQlf/boo_NbQ7i8LYu6f7q4rnn/eccf743b-f84f-655a-e8cb-52655df7bc4ccampaign_creators_gMsnXqILjp4_unsplash.jpg)

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

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

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

1. Кто понимает принцип работы продукта на всех уровнях (сюда входят команды разработчиков продукта и спецификаций).

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

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

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

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

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

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

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

Смотрите на документацию по продукту как на сам продукт.

![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_JdDBUtqTll6qYQgc9/boo_NbQ7i8LYu6f7q4rnn/cd6029ed-9933-9a5f-4007-c4d28888fa5ebram_naus_n8Qb1ZAkK88_unsplash.jpg)

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

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

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

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

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

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

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

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

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

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

Отзывы о документации по продуктам

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

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

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

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

Это может произойти разными способами:

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

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

Чрезмерное использование неявных терминов: В справочнике сокращения могут иметь мало смысла, даже если эти фразы не являются акронимами. Это трудно воспринимается, но некоторые слова, такие как «статус», «id», «полномочия», содержат неявный смысл, замаскированный под явный. Используйте конкретные обозначения, например, «UserID», а не «UID».

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

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

Инструменты обратной связи, такие как функция Vocally a Docsie, — это отличный способ получить и оценить шаблоны навигации и изучить, как ваши клиенты просматривают документацию по продукту. [Узнайте 7 золотых правил сбора отзывов здесь] (https://www.docsie.io/blog/articles/7-golden-rules-to-successfully-approach-customer-feedback/).

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

Как написать исчерпывающую документацию по продукту

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

Что происходит с большинством документации по продуктам?

![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_6UrbmSp116NpfVK1l/boo_NbQ7i8LYu6f7q4rnn/64a68ac0-4ef1-308c-ad6b-5ce4525f5301jeshoots_com__2vD8lIhdnw_unsplash.jpg)

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

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

Как исправить ситуацию и написать лучшую документацию по продукту, которую наши клиенты будут читать с удовольствием?

![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_NSTKBpS5BKDoj224Y/boo_NbQ7i8LYu6f7q4rnn/d83ce28b-38c3-bb53-8a14-2e1212d0fc5cscott_graham_5fNmWej4tAA_unsplash.jpg)

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

Потенциал хорошо написанной документации по продукту

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

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

Эффективная документация по продукту — это низкозатратный подход к улучшению клиентского опыта

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

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

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

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

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

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

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

Теперь приступим:

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

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

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

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

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

https://www.docsie.io/blog/articles/collaboration-to-create-well-polished-product-documentation/

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

Используйте Docsie как способ ускорить создание потрясающей документации по продукту

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

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

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

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

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

Возможность назначать задания и комментировать для беспрепятственного сотрудничества: Docsie имеет потрясающие инструменты для совместной работы с командой разработчиков документации по продукту. Вы можете назначать комментарии, ставить задачи и распределять роли, чтобы лучше контролировать, какие задачи выполняются тем или иным пользователем, работающим над проектом документации продукта с помощью Docsie. [Чтобы узнать больше, посетите этот блог здесь] (https://www.docsie.io/blog/articles/collaboration-to-create-well-polished-product-documentation/).

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

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

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

В этом разделе мы разделим объяснение этих плагинов для портала знаний на три части.

ЧАСТЬ 1: В первой части мы покажем, что такое «Display Version Picker», «Display Language Picker», «Display Section Anchors» и «Display Footer Navigation».

ЧАСТЬ 2: В этой части мы покажем плагин ‘Выделение кода’, ‘Поиск’ и ‘Поделиться в социальной сети’.

ЧАСТЬ 3: В третьей части мы покажем плагин ‘Предварительный просмотр изображений’, ‘Метаданные документа’ и ‘Автоподсветка раздела’.

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

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

Затем в Deployments мы можем получить доступ к плагинам после создания нового развертывания через ‘Configure a new deployment+’.

Затем нажмите ‘More options’, что позволит вам добавить эти плагины в вашу развернутую документацию через ваш встроенный скрипт или через портал Docsie.

Другой вариант — получить доступ к плагинам порталов знаний Docsie через кнопку «Обновить конфигурацию развертывания» под уже опубликованной документацией.

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

ЧАСТЬ 1:

Теперь, когда мы знаем, как получить доступ к Docsie Pluggin, давайте перейдем к ЧАСТЬ 1.

Чтобы посмотреть часть 1 видеоучебника, пожалуйста, посмотрите это видео здесь:

.

Давайте начнем с «Выбор версии дисплея» и «Выбор языка дисплея».

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

![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_15B6AEHxast4mhcXQ/boo_NbQ7i8LYu6f7q4rnn/3dc1ff60-4be8-3457-f12c-be1f2bbff93aimage.png)

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

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

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

Далее «Отображение навигации в нижнем колонтитуле».

Этот плагин добавляет кнопку навигации в правом нижнем углу вашей Книги документации. Она выглядит примерно так.

Таким образом, вашим клиентам будет удобнее ориентироваться в вашей документации.

ЧАСТЬ 2:

Чтобы посмотреть часть 2 видеоурока, пожалуйста, посмотрите это видео здесь:

.

В этой части мы покажем плагин «Выделение кода», «Поиск» и «Поделиться в социальной сети».

Начнем с плагина ‘Code Highlighting’.

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

Теперь давайте погрузимся в плагин Search.

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

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

![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_8G9KP4zImdeOeNVMG/boo_NbQ7i8LYu6f7q4rnn/5e64c628-aa23-b6c3-d17c-499a87ea0265image.png)

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

Следующий плагин — Share To Social Networks.

![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_0drhefPXvSjuyfjVF/boo_NbQ7i8LYu6f7q4rnn/382f6e99-41cc-698a-b66a-81ac9175b29cimage.png)

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

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

ЧАСТЬ 3:

Для того, чтобы посмотреть часть 3 видеоурока, пожалуйста, посмотрите это видео здесь:

.

В третьей части мы покажем плагин ‘Image Preview’, ‘Document Metadata’ и ‘Auto-highlight Section’.

Начнем с плагина предварительного просмотра изображений

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

Далее ‘Метаданные документации’

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

![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_XuX34nMuBsiRqXWVJ/boo_NbQ7i8LYu6f7q4rnn/89db1bbb-c9bf-50e9-5344-36717448c436image.png)

Теперь давайте рассмотрим плагин ‘Auto-Highlight Section Plugin

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

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

Все эти и другие инструменты предоставляет вам платформа Docsie. Если вы еще не попробовали ее, мы советуем вам это сделать. Нажмите здесь

Также, если у вас есть вопросы, пожалуйста, свяжитесь с нами по адресу hello@docsie.io.