Skip to main content

此版本的 GitHub Enterprise Server 将于以下日期停止服务 2024-09-24. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

让内容可在搜索中查找

遵循以下 SEO 最佳做法,帮助用户使用搜索引擎来查找 GitHub 文档。

关于搜索引擎优化 (SEO)

搜索引擎优化 (SEO) 是在搜索引擎(如 Google 和必应)结果中获取 Web 内容可见性的做法。 Google 搜索是 GitHub Docs 的热门引荐者,也是我们用户最常见的入口点。

我们可以计划和编写内容以改进 SEO。 更好的 SEO 可以改进搜索文档的用户的体验,因为它让用户更有可能使用首选搜索词找到要查找的信息。

内容 SEO 的最佳做法

良好的 SEO 需要针对特定受众规划内容,并且关注他们用于搜索的关键字。 请遵循以下最佳做法以改进文章的 SEO。

选择目标受众

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

  • 使用读者使用的关键字。
  • 使内容与需求和任务相符。
  • 提供适当数量的上下文和背景信息。

响应搜索意向

围绕搜索意向创建内容:驱动目标受众成员联机搜索信息的任务、问题或难题。

  • 开展搜索意向研究。 例如,分析相关查询的搜索引擎结果页 (SERP)。
  • 了解用户需求。 使用多个信息源,例如客户反馈、用户调查和指标数据。

使用清晰的语言

遵循“GitHub Docs 的最佳做法”中的指南,包括:

  • 确保每篇文章都有一个清晰的独特主题。
  • 首先在文章中放置优先级更高的内容。
  • 让文章具有结构性,提供清晰的标题。
  • 遵循“风格指南”来编辑内容,从而保持一致性。

合并关键字

将受众使用的关键字或热门搜索词合并到页面副本和元数据中。 例如,如果要撰写有关“付费”的内容,但受众主要使用“成本”和“付款”,请改用这些词语。

Google 和必应都提供了关键字研究工具,帮助你发现相关的关键字。 Docs 团队还查询 Google 搜索控制台数据,以了解通过哪些搜索词可搜索出有关 GitHub Docs 的页面。

包括元数据

在前辅文中使用完整的元数据。 若要查看可用的值,请参阅“使用 YAML 前辅文”。

在 GitHub Docs 上,元素 intro 显示为页面副标题,并作为 HTML 元数据说明。 文章标题作为 HTML 页标题。 提供良好的 SEO:

  • 编写标题和 intro,让它们具有互补性,包含大量关键字。 考虑它们在研究中的呈现方式。
  • 为所有图像附带包含大量关键字的替换文字,这也是搜索引擎使用的元数据。 请参阅 GitHub Docs 风格指南中的“替换文字”。

遵循 GitHub Docs 风格指南中的“链接”,链接到 GitHub Docs 和高质量对等网站上的其他与任务相关的页面。

仔细维护重定向,确保传入链接不会中断。

保持准确性

确保内容中没有错误,包括在事实、拼写和样式方面。 定期审核内容以删除错误(例如断开的链接),并停用不需要的内容。 请参阅“配置重定向”。