Почему документация по API — это золото контент-маркетинга

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

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

Это немного сложнее… Но это не должно казаться невозможным.

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

Когда вы смотрите на успех экосистемы AppExchange от Salesforce и процветающей экосистемы разработчиков Shopify, становится совершенно очевидным, что этот подход может принести невероятный доход как партнерам, так и бренду. В 2021 году партнеры-разработчики Shopify заработали более 230 миллионов долларов, а исследование IDC (International Data Corporation) прогнозирует, что Salesforce внесет 1,2 триллиона долларов в местную экономику по всему миру. Не плохо а? Посмотрите на этот рост от Shopify…

Это не происходит случайно.

Это происходит, когда вы инвестируете в свое сообщество и инвестируете в контент, который их поддержит.

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

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

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

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

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

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

Один из лучших способов сделать это — инвестировать в качественную документацию.

Отличная документация по API сильно недооценивается как стратегия контент-маркетинга в B2B SaaS.

Хорошая документация может:

• Увеличьте авторитетность домена через ссылки
• Установите доверительные отношения с вашими клиентами
• Сохраняйте своих клиентов надолго
• Помогите поднять продукт
• Вдохновляйте освещение в СМИ
• Зарабатывайте качественные обратные ссылки

И многое другое… Вот снимок некоторых из самых популярных центров документации и преимуществ контент-маркетинга, которые они предоставляют своим брендам:

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

Давайте приступим к этому…

Держите документацию в чистоте

Здесь не нужно изобретать велосипед.

Такие компании, как Shopify, Stripe, WorkOS и Gitlab, показали нам, как выглядит отличная документация. Формат не должен быть слишком сложным.

Будь проще.

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

Упростите навигацию

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

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

Это не то место, где вы выигрываете поездку в Канны.

Здесь вы выигрываете повышение.

Еще один интересный подход, реализованный людьми из WorkOS, — это возможность навигации по вариантам использования. Stripe делает это хорошо, имея страницу Docs перед страницей API. Вы можете выбрать, ищете ли вы документацию по бизнес-операциям или документацию по финансовым услугам…

Другой продукт, который делает это действительно хорошо, — Twilio:

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

Структурируйте свои URL-адреса с превосходством

Хотите увидеть цифровую магию? Посетите документацию Stripe, просмотрите URL-адрес и прокрутите…

При прокрутке URL-адрес меняется с docs/ api на /api/authentication, на /api/metadata и, таким образом, на любое другое расширение, которое у них есть. Это красота. Почему?

Потому что на каждый из этих URL-адресов можно ссылаться, и они направляют людей в этот конкретный раздел. Это идеальный пользовательский интерфейс (бесконечная прокрутка), при этом предлагающий Stripe возможность индексировать эти отдельные разделы в Google через свой домен. Это то, из чего сбываются мечты оптимизатора…

Вы можете не только потреблять контент, не переходя на новую страницу, но и делиться определенными разделами, используя URL-адрес. Сегодня у Stripe более 45 000 ссылающихся доменов, ссылающихся на их документацию. Стратегия превращения каждого ключевого раздела в URL-адрес, на который можно ссылаться, — отличный способ гарантировать, что писатели, инженеры и разработчики будут ссылаться на него, когда это уместно.

Не пытайтесь продавать свою документацию

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

Главным образом потому, что маркетологи ЛЮБЯТ пытаться найти способы оживить вещи и добавить свою «сущность бренда» во все. Это не обязательно с документацией. Избавьтесь от болтовни и не пытайтесь продать свой продукт или различные функции. Придерживайтесь того, чего хотят люди: кодекса и направления.

Не позволяйте людям «предполагать свои ошибки»

Это довольно тактический совет, но разработчики хотят выяснить, ПОЧЕМУ что-то не работает.

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

Мой последний совет, когда дело доходит до создания отличной документации, заключается в следующем…

Сначала пишите для людей, потом для ботов

Возможно, это самая важная часть документации.

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

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

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

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