Подготовка документации при запуске нового продукта: 15 лучших практик¶

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

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

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

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

• Требования к продукту (PRD) – Документ с требованиями к продукту или PRD — это внутренняя документация, помогающая компаниям соответствовать критериям релиза. В нем описывается, что готовый продукт должен делать для пользователя, без уточнения как и где. Команды разработки и тестирования используют PRD для согласования продукта с бизнес-требованиями перед выпуском. PRD распространены в программных продуктах, но могут использоваться для любой продуктовой дорожной карты.

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

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

• Маркетинговые материалы – Возможно, вы не считаете это документацией к продукту, но это она и есть! Стиль и формат маркетинговых материалов влияют на то, как клиенты воспринимают ваш продукт, прежде чем начнут им пользоваться. Важно произвести хорошее впечатление. Как вы описываете новые функции продукта? Для какой аудитории он предназначен? Как это улучшит чью-то работу или личную жизнь? Именно это вы и ваша компания хотите, чтобы думали клиенты?

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

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

1: Начните!¶

Только начинаете работать с документацией к продукту? Отлично! Теперь не медлите с началом. Многие стремятся сделать документацию ИДЕАЛЬНОЙ, и в погоне за совершенством парализуются перед задачей. Запишите основную концепцию ваших сервисов, а затем сосредоточьтесь на доработке, чтобы впечатлить клиентов. Примечания к выпуску отлично подходят для определения основ, а затем можно развивать документацию дальше.

2: Будьте проще...¶

Сокращенно KISS (Keep It Simple, Stupid), это реальный принцип проектирования, который появился в ВМС США в 60-х годах. То же правило можно применить к документации продукта. Спросите себя: «Как донести необходимую информацию так, чтобы все демографические группы могли ее понять?»

Для оценки понятности текста рекомендуем использовать тест на читабельность Флеша-Кинкейда. Инструменты оценки контента, такие как Grammarly, часто используют эту систему. Стремитесь к уровню 8-го класса или возрасту 13-14 лет, чтобы максимизировать понятность содержания – проще говоря, насколько легко понять ваш текст.

3: Поймите целевую аудиторию¶

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

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

4: Сосредоточьтесь на ценности, а не на истории¶

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

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

5: Используйте форматирование для категоризации информации¶

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

Заголовки H1 — первое, что видят люди при переходе на страницу. H2 и H3 выступают как подзаголовки для тем, затронутых на странице. Можно использовать маркированные или нумерованные списки для группировки контента для удобного чтения, а также повысить шансы на получение расширенных сниппетов для улучшения SEO и видимости в результатах поиска. Если вы знакомы с Markdown, онлайн-редактор, такой как Docsie, предлагает множество вариантов форматирования, чтобы ваша документация выделялась!

6: Храните документацию в централизованном месте¶

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

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

7: Изображение стоит тысячи слов¶

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

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

8: Обучение vs Цели vs Понимание vs Информация¶

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

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

• Цели – Этот тип контента должен помочь пользователям достичь цели, например, «Как экспортировать PDF-файл из Docsie». В конце пользователь достигнет цели: экспорта PDF.

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

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

9: Сделайте контент удобным для поиска¶

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

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

10: Подготовка к сбору ценных отзывов¶

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

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

11: Ссылайтесь на страницу при упоминании темы¶

Эта практика опирается на SEO и структуры навигации веб-страниц.

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

12: Ясность, а не двусмысленность¶

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

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

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

Что вам больше нравится?

13: Создавайте шаблоны для ускорения создания документов¶

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

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

14: Установите тон и руководство по стилю для авторов¶

Насколько свободны ваши авторы?

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

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

• Стилистические рекомендации – Этот документ может объяснять миссию компании и то, как авторы могут следовать определенному стилю при написании и форматировании страниц. Здесь могут быть включены целевые персоны, принципы SEO, такие как мета-описания, и требования к цитированию или ссылкам (Chicago, AP Style и т.д.).

15: Публикуйте документацию с помощью мощной платформы базы знаний¶

Если ваш письменный контент — это топливо, какое транспортное средство вы используете, чтобы донести сообщение?

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

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

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