Создание доступных для поиска содержимого

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

В этой статье

О оптимизации поисковой системы (SEO)

Оптимизация поисковой системы (SEO) — это практика получения видимости веб-содержимого в результатах поисковой системы, таких как Google и Bing. Поиск Google — это лучший ссылок на GitHub Docs и наиболее распространенную точку входа для наших пользователей.

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

Рекомендации по SEO содержимого

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

Выбор целевой аудитории

Изучите и напишите в определенную аудиторию содержимого: разработчики, администраторы или учащиеся кода. Этот пример поможет вам:

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

Реагирование на намерение поиска

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

  • Проведение исследования намерений поиска. Например, анализируйте страницы результатов поисковой системы (SERPs) для соответствующих запросов.
  • Общие сведения о потребностях пользователей. Используйте несколько источников, таких как отзывы клиентов, интервью пользователей и метрики.

Использование ясного языка

Следуйте инструкциям в Рекомендации по GitHub Docs, в том числе:

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

Включение ключевых слов

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

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

Включение метаданных

Используйте полные метаданные в frontmatter. Сведения о доступных значениях см. в разделе Использование frontmatter YAML.

В GitHub Docs intro элемент отображается как подзаголовок на странице и служит описанием метаданных HTML. Название статьи служит заголовком HTML-страницы. Для хорошего SEO:

  • Напишите заголовок и быть взаимодополняющими и intro богатыми ключевыми словами. Рассмотрим, как они будут отображаться в исследованиях.
  • Сопровождайте все изображения с замещающим текстом с форматированными ключевыми словами, который также является метаданными, используемыми поисковыми системами. См . замещающий текст в руководстве по стилю GitHub Docs.

Связывание с другими страницами, соответствующими задачам, на GitHub Docs и высококачественных одноранговых сайтах, следуя ссылкам в руководстве по стилю GitHub Docs.

Убедитесь, что входящие ссылки не прерываются, тщательно сохраняя перенаправления.

Обеспечение точности

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