К содержимому

Продвижение в интернете

Технический блог и документация как источник поискового трафика

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

редакция «Топика»~5 мин

Разделы материала

Чем технический читатель отличается

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

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

Где брать темы

Хорошие темы не придумываются за столом, их собирают:

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

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

Документация и блог: разные задачи

Документация и технический блог
ФорматКто читаетКак устроенКак часто меняется
ДокументацияТот, кто уже пользуется или выбирает продуктСправочные разделы, по одной задаче на страницуПри каждом изменении продукта
РуководстваТот, кто решает задачу впервыеПошаговый сценарий от начала до результатаКогда меняется процесс
Технический блогТот, кто ищет решение проблемы в целомРазборы, сравнения подходов, истории решенийНовые материалы по плану

Частая ошибка — держать документацию одной огромной страницей или в виде файла для скачивания. Поисковая система не сможет показать человеку нужный раздел. Делите документацию на страницы с собственными адресами и заголовками, которые совпадают с формулировкой задачи: не «Раздел 4.2», а «Настройка уведомлений по почте».

Как устроить хороший разбор

Сильный технический материал обычно содержит:

  1. Контекст. Какая задача решается и в каких условиях — версия окружения, ограничения, исходное состояние.
  2. Короткий ответ. Одним абзацем: что нужно сделать. Многие читатели ищут именно его.
  3. Шаги. По одному действию на шаг, с примером команды или конфигурации.
  4. Рабочий пример. Код, который можно скопировать и запустить. Проверьте его перед публикацией.
  5. Ограничения. Когда этот способ не подходит и что выбрать вместо него.
  6. Диагностика. Что делать, если результат не получился: типичные сообщения об ошибках и их причины.

Примеры кода — тоже текст для поиска

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

Пример: как вопрос превращается в материал

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

Обратите внимание: в материале нет рекламы. Сервис упоминается только там, где показано, где менять настройку. Это и делает текст полезным для всех, кто его найдёт.

Структура и перелинковка

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

Обновление — половина работы

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

Как понять, что блог работает

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

Чек-лист

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

Типичные ошибки

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

Документация в одном файле. Огромная страница или документ для скачивания не находится по конкретным вопросам.

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

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

Вопросы и ответы

Кто в маленькой команде должен писать технический блог?

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

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

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

Документация должна быть открыта для поиска или только для клиентов?

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