编写可搜索的文档

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

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

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

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

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

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

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

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

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

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

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