Одной из лучших практик при запуске нового продукта является подготовка к выпуску продукта. В частности, мы хотим сосредоточиться на написании документации по новому продукту для поддержки запуска продукта. Без нее у потенциальных пользователей не будет необходимой информации, которую можно будет использовать в качестве ориентира после приобретения вашего нового решения.
Как часть более широкой маркетинговой стратегии, менеджеры продуктов и члены продуктовых команд должны продолжить чтение, чтобы узнать о 15 лучших практиках, которым следует следовать во время следующего запуска. К концу статьи вы поймете, как сделать эти важные документы лучшими из возможных!
**О каких видах документации по продукту я должен знать?
Прежде чем перейти к списку лучших практик, давайте уточним, какие типы документации по продукту существуют, и какова цель каждого из них:
-
Документация требований к продукту - Документ требований к продукту или PRD - это вид внутренней документации по продукту, используемый для того, чтобы помочь компании соответствовать критериям выпуска. В нем объясняется, что конечный продукт должен сделать для пользователя, без конкретного определения того, как и где. Затем команды разработчиков и тестировщиков используют PRD для приведения продукта в соответствие с бизнес-требованиями, готовыми к выпуску. PRD широко распространены в программных продуктах, но их можно использовать для соблюдения любой дорожной карты продукта.
-
Руководства пользователя и самообслуживание - Командам разработчиков продукта необходимо создать руководства пользователя как обязательное условие успешного запуска продукта. Как следует из названия, это документация, помогающая конечным пользователям максимально повысить производительность при использовании нового продукта. Здесь следует полностью объяснить все основные функциональные возможности, с которыми сталкивается пользователь, чтобы клиенты могли получить максимальную пользу. Еще лучше разместить эти руководства во внешней базе знаний самообслуживания, чтобы клиенты могли помочь себе сами!
![] (https://cdn.docsie.io/workspace_PfNzfGj3YfKKtTO4T/doc_Eaf0xsgp4QfJLQPUN/file_cWXkDOoQWZe4VTtxB/3f77ef88-6b1c-476b-00bf-403bf0fd3f7dimage.png)
-
Руководства по настройке, установке и конфигурированию - Если продукт требует настройки, установки и конфигурирования, это еще один актив технической документации по продукту, который вам необходимо создать. Цель - наглядно проиллюстрировать эти процессы с точки зрения пользователя и, при необходимости, разработчика. Это может охватывать несколько устройств и несколько операционных систем, если речь идет о документации по программному обеспечению; об этом следует помнить.
-
Маркетинговые активы - Вы можете не думать, что это документация по продукту, но это так! Стиль и формат маркетинговых активов влияет на то, как клиенты воспринимают ваш продукт еще до того, как начнут его использовать. Произвести хорошее впечатление жизненно важно. Как вы описываете новые возможности продукта? Для какой аудитории он предназначен? Как это улучшит чью-то работу или личную жизнь? Хотите ли вы и компания в целом, чтобы покупатели думали именно так?
После этого учебника по документам о продукте, далее следует список лучших практик:
1: Начните!
Только начинаете работать с документацией по продуктам? Отлично! Не медлите с началом. Многие люди хотят, чтобы документация на продукцию была СОВЕРШЕННОЙ; и в погоне за совершенством они становятся парализованными задачей. Изложите на бумаге основную концепцию ваших услуг, а затем сосредоточьтесь на приведении их в порядок, чтобы произвести впечатление на ваших клиентов. Заметки о выпуске отлично подходят для определения основ, а затем вы можете развивать этот документ.
![] (https://cdn.docsie.io/workspace_PfNzfGj3YfKKtTO4T/doc_Eaf0xsgp4QfJLQPUN/file_Emt4IHPuQCw8QvlWh/de7b651e-3c21-5769-3d3c-98b10afa2861image.png)
2: Keep it Simple, Stupid...
Сокращенно называемый KISS, это реальный принцип проектирования, который (каламбурно) был принят в военно-морском флоте США в 60-х годах. Это же правило можно применить и к документации по продукту. Спросите себя: "Как передать необходимую информацию таким образом, чтобы ее могли понять все демографические группы?".
Чтобы применить это к вашему видению продукта, мы рекомендуем использовать тест на читабельность Флеша-Кинкейда. Инструменты оценки контента, такие как Grammarly, обычно используют эту систему. При анализе письменного контента вы получаете оценку, эквивалентную оценке средней школы США. Нацельтесь на 8 класс или 13-14 лет в качестве школьного возраста, чтобы максимизировать интерпретируемость контента - подождите, мы могли бы сказать... насколько легко понять написанное вами.
3: Поймите целевую аудиторию.
Итак, вы начали, и все было просто. Теперь вам нужно знать, для кого вы пишете... Например, целевая аудитория компаний, занимающихся разработкой программного обеспечения, будет сильно отличаться от целевой аудитории производителей автомобилей.
Давайте представим себе компанию по производству программного обеспечения для образования, которая специализируется на простых инструментах, помогающих молодым студентам шаг за шагом изучать концепции. Первой мыслью в вашей голове может быть: "Итак, целевая аудитория - это дети, верно?". Не обязательно... Целевая аудитория - это лица, принимающие решения о приобретении программных пакетов в детском саду или средней школе - например, ИТ-отдел и внутренние заинтересованные лица, отвечающие за закупки. Вторичной аудиторией могут быть молодые ученики, которые могут увидеть образовательное программное обеспечение в естественных условиях и выступить за его использование в своей школе.
4: Фокусируйтесь на ценности, а не на истории.
Хотя все любят хорошие истории, клиенты хотят знать, какую ценность предлагает ваш продукт. Упростит ли он задачу или рабочий процесс? Доступен ли ваш продукт в офлайне, в отличие от конкурентов, которые работают только в онлайне? Делает ли ваш продукт задачу быстрее, чем другие конкурирующие продукты?
Эти примеры представляют собой уникальные торговые точки (УТП) для конкретного предложения. Сосредоточение внимания и выделение УТП привлечет потенциальных клиентов и поможет им понять, что у вас есть такого, чего нет у других, чтобы увеличить долю рынка. Вы можете определить УТП, проведя конкурентный анализ конкурентов в вашей отрасли.
5: Используйте форматирование для категоризации информации.
Документация не должна представлять собой большой блок текста. Это затрудняет сканирование и навигацию для конечных пользователей. Вместо этого используйте заголовки и другие возможности форматирования, чтобы разбить текст на части.
Заголовки H1 - это первое, что видят люди, когда переходят на страницу. Заголовки H2 и H3 служат в качестве подзаголовков для тем, рассматриваемых на странице. Вы можете использовать пулевые точки или нумерованные списки, чтобы сгруппировать контент для удобства чтения, и даже получить право на Rich Snippets для улучшения SEO и видимости в SERPS. Если у вас есть знания Markdown, онлайн-редактор Markdown, такой как Docsie, предлагает множество вариантов форматирования, чтобы сделать ваши документы о продукте особенными!
6: Храните документацию в центральном месте.
Нет ничего хуже, чем выпустить техническую документацию, а затем понять, насколько сложным будет ее долгосрочный мониторинг и управление. Что делать, если документация нуждается в обновлении? Где находится оригинальный документ, и как мы можем выпустить новые версии страниц? Как насчет перевода этого контента на другие языки?
Для этой лучшей практики мы должны упомянуть Docsie! Онлайн-программа базы знаний позволяет хранить документы в едином централизованном облачном хранилище. Отсюда сотрудники и подрядчики могут совместно работать над контентом, чтобы ускорить завершение работы, готовой к запуску. Docsie предлагает управление контролем версий при необходимости обновления знаний, а также управление языками для локализации глобального контента. Если вы хотите автоматизировать создание глобального контента, у нас также есть замечательный бот для языкового перевода ghost AI, который точно переводит за вас в фоновом режиме!
7: Картинка говорит тысячу слов.
Хотя написание длинного объяснения того, как сделать ту или иную вещь, может сработать, это неэффективный способ обучения конечных пользователей. Вместо этого покажите им с помощью картинок или даже движущихся картинок!
Попробуйте создать сопроводительное видеоруководство для каждого документа по продукту. Таким образом, те, кто предпочитает читать, смогут просмотреть текст, в то время как визуальные ученики смогут выбрать видео. Аналогичным образом, GIF-файлы и изображения могут помочь пользователям понять, что вы имеете в виду, особенно в пользовательском интерфейсе (UI) программного обеспечения. Приспособление к различным стилям обучения поможет вам помочь более широкому кругу пользователей, что означает больший потенциал для вашего продукта.
![] (https://cdn.docsie.io/workspace_PfNzfGj3YfKKtTO4T/doc_Eaf0xsgp4QfJLQPUN/file_X78cQgHAcdaqo3Jyo/6fd3a530-7742-61d2-28d7-a05b231ad08aimage.png)
8: Обучение vs Цели vs Понимание vs Информация.
Какова цель документа? Пользовательское намерение имеет решающее значение для документации по онлайн-продуктам и помогает согласовать содержание с участками пути пользователя.
-
Обучение - Если человек никогда раньше не видел какую-либо вещь, обучающий контент поможет ему понять основные принципы.
-
Цели - Этот тип контента должен помочь пользователям достичь цели, например, "Как экспортировать файл PDF из Docsie". К концу пользователь достигнет цели: экспортирует PDF-файл.
-
Понимание - также называемый исследованием, предназначен для клиентов, которые уже имеют рабочие знания по какому-либо вопросу, но хотят понять его глубже.
-
Информация - У клиента есть вопрос, и он хочет получить конкретный ответ. Это может быть простая информация о погоде в реальном времени в определенном месте или видео о том, "как построить дом на дереве".
9: Сделайте его доступным для поиска
Прежде чем вы выложите эту документацию в открытый доступ, могут ли ваши пользователи искать ключевые слова в тексте?
Если нет, мы рекомендуем найти платформу для документации, которая поддерживает такую возможность. Сдерживающим фактором номер один для пользователей является невозможность быстро найти информацию. Это приводит к разочарованию, дополнительной нагрузке на службу поддержки клиентов, если они не могут найти нужную информацию, и негативному общему впечатлению клиентов (CX). О, Docsie поддерживает глобальный поиск, если вам было интересно!
10: Подготовка к сбору действенных отзывов.
Составители документации знают, что первоначальная версия контента обязательно изменится в дальнейшем. Пока публика не увидит документацию, ваши авторы могут только обмениваться идеями и отзывами друг с другом.
Мы считаем, что после публикации документации необходимо обеспечить сбор отзывов. Таким образом, ваши авторы смогут превратить любые негативные моменты, связанные с содержанием, в позитивные, прислушиваясь к мнению реальных клиентов и конечных пользователей. Нет необходимости искать что-то еще, вы можете воспользоваться преимуществами сбора отзывов в Docsie!
11: Ссылка на страницу при упоминании темы
Эта передовая практика опирается на SEO и навигационные структуры веб-страниц.
Когда вы упоминаете ключевое слово, ставите ли вы на него ссылку? Когда вы ссылаетесь на другие темы, пользователи могут еще не понимать другую тему в контексте текущей страницы. Вы должны ссылаться на все упомянутые темы, по которым есть документация, так как это позволяет читателям быстро обращаться к подтемам, изучая основную тему.
12: Ясность, а не двусмысленность.
Ясность побеждает двусмысленность при написании документации по продукту. Вы можете использовать простой английский язык, чтобы избежать двусмысленности, что в основном означает отказ от жаргона и технического языка, если это не является абсолютно необходимым. Если вы все же используете жаргон, не забудьте сразу после него написать упрощенное определение для неспециалистов.
"Если у вас возникли проблемы с пониманием информации в этой документации, пожалуйста, обратитесь за дополнительными подробностями о том, как преодолеть эти трудности с пониманием, к представителю нашей службы поддержки клиентов".
"Если отображаемое содержание трудно понять, вы можете обратиться за помощью в службу поддержки клиентов".
Что вам больше нравится?
13: Создание шаблонов для ускорения работы с документами
При запуске нового продукта ускорение процесса создания документации является приоритетной задачей. Это можно сделать с помощью шаблонов.
Шаблоны определяют многократно используемую структуру страниц, помогая авторам создавать контент быстрее и с большей последовательностью. Вы также можете создать несколько шаблонов для разных стилей контента. Docsie предлагает ряд готовых шаблонов для использования, а также поддержку пользовательских шаблонов.
14: Установление тона голоса и руководство по стилю для писателей
Насколько свободны ваши писатели?
Важно контролировать писателей, поскольку это может привести к несогласованности в окончательных вариантах документации по продукту. Вы можете сделать это с помощью рекомендаций по тону голоса (ToV) и руководств по стилю написания контента.
-
Тон голоса - дело не в том, что вы сказали... а в том, как вы это сказали. Хотите ли вы, чтобы авторы были формальными и корректными или более непринужденными? Допускается ли юмор, или темы более серьезные? Является ли ваш контент более разговорным и страстным, или вам нужны только холодные и жесткие факты?
-
Руководство по стилю - в этом документе можно объяснить миссию компании и то, как авторы могут следовать установленному стилю при написании и форматировании страниц. Сюда могут быть включены пользовательские персоны, на которые следует ориентироваться, принципы SEO, такие как метаописания, требования к цитированию или ссылкам (Chicago, AP Style и т.д.).
15: Публикация документации с помощью мощной платформы базы знаний.
Если ваш письменный контент - это топливо, какое средство вы используете для донесения информации?
Мощная платформа базы знаний необходима для развертывания качественной документации по продукту. Если документы становятся недоступными или страницы медленно загружаются, все усилия, затраченные на создание этих документов, пойдут насмарку.
Вам необходима возможность импорта существующих документов, совместной работы над контентом с внутренними командами, создания и редактирования новых документов, встраивания динамического богатого контента и публикации на сайте знаний. Контроль версий также важен для долгосрочного обновления документации, наряду с управлением языками и автоматическим переводом для глобальной локализации контента.
![] (https://cdn.docsie.io/workspace_PfNzfGj3YfKKtTO4T/doc_Eaf0xsgp4QfJLQPUN/file_AQjjiMz02RUxwJ6Yh/f523c296-d7ed-b928-222d-f514ebeb559dimage.png)
Вы угадали! Все эти функции доступны в Docsie. Воспользуйтесь этими возможностями, попробуйте наш тарифный план Free Forever, чтобы начать работу!