跳至主要内容

让内容在搜索中可被发现

遵循以下 SEO 最佳实践,帮助用户通过搜索引擎找到 GitHub 文档。

关于搜索引擎优化(SEO)

搜索引擎优化(SEO)是指在搜索引擎(如 Google 和 Bing)的搜索结果中获取网页内容可见性的做法。Google 搜索是 GitHub 文档的主要流量来源,也是用户最常使用的入口。

我们可以通过策划和撰写内容来提升 SEO。更好的 SEO 能提升搜索文档的用户体验,因为这会让他们更有可能使用自己偏好的搜索词找到所需信息。

内容 SEO 的最佳实践

优秀的 SEO 需要为特定受众规划内容,并关注他们使用的搜索词。遵循以下最佳实践,可提升文章的 SEO 表现。

选择目标受众

了解并针对内容的特定受众撰写:开发者、管理员或代码学习者。这有助于您

  • 使用读者使用的词语。
  • 使内容与他们的需求和任务相关。
  • 提供适当的上下文和背景信息。

回应搜索意图

围绕搜索意图撰写内容:即促使目标受众成员在线搜索信息的任务、问题或疑问。

  • 开展搜索意图研究。例如,分析搜索引擎结果页面(SERP)中相关查询的表现。
  • 了解用户需求。使用多种来源,如客户反馈、用户访谈和指标。

使用清晰的语言

遵循GitHub 文档最佳实践中的指导,包括

  • 确保每篇文章都有明确、独立的主题。
  • 在文章中先呈现更高优先级的内容。
  • 使用清晰的标题组织文章结构。
  • 按照样式指南进行编辑,以确保一致性。

融入关键词

将关键词(即受众常用的热门搜索词)融入页面正文和元数据。例如,如果您在撰写“计费”相关内容,但受众主要使用“成本”和“付款”,则应使用这些词汇。

Google 和 Bing 都提供关键词研究工具,帮助您发现相关关键词。文档团队还会查看 Google Search Console 数据,以了解哪些搜索词会将用户引导至 GitHub 文档页面。

包含元数据

在 frontmatter 中使用完整的元数据。要查看可用的值,请参阅使用 YAML frontmatter

在 GitHub 文档中,intro 元素作为页面副标题显示,并用作 HTML 元数据描述。文章标题则用作 HTML 页面标题。为了获得良好的 SEO

  • 编写标题和 intro 时,使其互补且包含丰富关键词。考虑它们在搜索中的呈现方式。
  • 为所有图片添加包含关键词的 alt 文本,它同样是搜索引擎使用的元数据。请参阅 GitHub 文档样式指南中的Alt text(替代文字)

在遵循链接(GitHub 文档样式指南)规范的前提下,适度链接到 GitHub 文档中与任务相关的页面及高质量的同行站点。

通过仔细维护重定向,确保外部链接不会失效。

保持准确性

确保内容在事实、拼写和风格上没有错误。定期审计内容,删除诸如失效链接等错误,并清除不再需要的内容。请参阅配置重定向

© . This site is unofficial and not affiliated with GitHub, Inc.