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

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

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

Но что входит в создание документации по продукту? И как вы можете настроить собственную документацию на своем веб-сайте?

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

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

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

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

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

Это делает ваших клиентов более успешными

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

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

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

Это уменьшает вашу нагрузку на поддержку

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

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

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

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

Это может быть хорошим инструментом маркетинга и продаж

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

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

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

Например, Stripe известен одной из лучших документаций по продуктам. Если вы зайдете в Twitter, вы увидите, что многие люди рекомендуют Stripe из-за качества документации Stripe:

Это делает ваших сотрудников более эффективными

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

Четыре отличных примера документации продукта из реальной жизни

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

1. Полоса

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

2. Адьен

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

3. Твилио

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

4. Слабость

Slack — еще один инструмент с очень хорошо написанной и полезной документацией. Вы можете просмотреть полную документацию Slack здесь.

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

Лучшее программное обеспечение для документирования продуктов

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

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

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

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

Вот два лучших решения…

Героическая база знаний (Heroic KB)

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

Если вы уже используете WordPress для веб-сайта своей компании, вы можете добавить базу знаний Heroic на свой сайт, чтобы создать собственный центр документации. Или, если вы этого не сделаете, вы можете создать специальную установку WordPress для своей документации. В последнем случае вас также может заинтересовать тема документации KnowAll WordPress .

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

База знаний Heroic также добавляет ряд полезных функций, в том числе:

• Мгновенный поиск Ajax.
• Поисковая аналитика.
• Рейтинги полезности статей.
• Прикрепленные файлы к статье.

Heroic Knowledge Base стоит всего 129 долларов.

Adobe РобоСправка

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

В этом случае вы можете предпочесть многоплатформенный инструмент для создания документации, такой как Adobe RoboHelp. Начиная с 29,99 долларов в месяц для индивидуального использования, это дороже, чем Heroic Knowledge Base. Однако, если вам нужна многоплатформенная разработка, эта дополнительная цена может стоить денег.

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

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

1. Поймите свою аудиторию

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

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

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

2. Изучите различные типы документации по продуктам

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

• Обзоры — в этих статьях содержится обзор того, как работает область вашего продукта, например, руководство «Начало работы».
• Пошаговые руководства — эти статьи показывают людям, как выполнить определенную задачу.
• Справочник — в этих статьях объясняются определенные концепции вашего продукта.
• Устранение неполадок — в этих статьях объясняется, как отлаживать/устранять распространенные проблемы, с которыми могут столкнуться клиенты.

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

3. Будьте последовательны в своем стиле и соглашениях об именах

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

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

4. Используйте простой язык и будьте лаконичны

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

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

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

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

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

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

6. Включите мультимедийные элементы

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

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

7. Используйте заголовки и добавьте оглавление

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

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

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

8. Всегда улучшайте и обновляйте свою документацию

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

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

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

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

Начните создавать потрясающую документацию по продукту уже сегодня!

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

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

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

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