撰写文档以便搜索引擎能够找到它

编写优质文档的关键之一是使其易于查找。读者会结合使用内部站点搜索和外部搜索引擎（如 Google 或 duckduckgo）。

为了确保 Ansible 文档易于查找，您应该：

在文档中使用清晰的标题

当我们想要查找某些内容时，我们都会使用简单的英语。例如，此页面的标题可以是以下任何一项：

我们真正想要描述的是 - 如何编写文档以便搜索引擎能够找到我的内容？这个简单的短语是本节标题的由来。在为文档创建标题时，花一些时间考虑一下您会在搜索框中输入什么来查找它，或者更重要的是，不熟悉 Ansible 的人会如何尝试查找这些信息。您的标题应该是对该问题的答案。

需要注意的一点是 - 您确实需要限制标题的长度。例如，“如何编写文档以便搜索引擎能够找到我的内容？”这样的完整标题太长了。搜索引擎会截断超过 50-60 个字符的任何内容。长标题在智能手机等较小的设备上也会换行。

Google 可以通过在搜索结果顶部添加“特色代码段”来优化搜索结果。特色代码段在第一个搜索结果的文档中提供了一个小窗口，它比其他搜索结果提供了更多详细信息，并且有时可以立即回答读者的疑问，或者至少验证链接的页面是否是读者正在寻找的内容。

Google 以编号步骤的形式返回特色代码段。在适当的情况下，您应在文档页面的顶部附近添加一个编号列表。这些步骤可以是读者将遵循的确切过程，也可以是对文档主题的高级介绍，例如此页面顶部列出的编号列表。

搜索引擎通常不会在搜索结果中返回 GitHub blob，至少不会在排名较高的位置。虽然可以并且有时需要从文档链接到 GitHub blob，但更好的方法是将这些信息复制到 Ansible 文档中的 .rst 页面。

虽然您可能无法使您的文档适应所有搜索优化，但在编写文档时请记住以下几点：

搜索引擎不会解析 html 页面中 `#` 之后的任何内容。例如，此页面上的所有子标题都附加到主页面 URL。因此，当我在搜索“使用编号列表用于零位置代码段”时，搜索结果将是此页面顶部的链接，而不是我搜索的子标题的直接链接。使用本地 TOC有助于缓解此问题，因为读者可以扫描页面顶部的标题并点击他们要查找的部分。对于关键文档，请考虑创建一个新的页面，该页面可以作为直接搜索结果页面。
使您的前几句话清楚地描述您的页面主题。搜索引擎不仅返回 URL，还返回 URL 上信息的简短描述。对于 Ansible 文档，我们没有在每个页面上嵌入描述元数据。相反，搜索引擎会返回页面上的前几句话（140 个字符）。这使得您的第一句话或两句话对正在搜索 Ansible 中内容的读者非常重要。