适用于大型语言模型的文档

为您的文档站点提供适配 LLM 的版本

我们正在构建功能，使大型语言模型（LLM）更容易摄取和处理您的文档内容。

随着LLM在信息检索和知识辅助方面变得越来越重要，确保您的文档对LLM友好可以显著提高这些模型理解和表示您的产品或服务的能力。

针对LLM优化的文档可确保像 ChatGPT、Claude、Cursor 和 Copilot 等 AI 系统能够检索并提供关于您的产品或 API 的准确、具有上下文的回应。

.md 页面

使用 GitBook，您文档站点的所有页面都会自动以 Markdown 文件形式提供。如果您在任何页面添加了 .md 扩展名，您将看到该页面以 Markdown 呈现的内容，您可以将其传递给 LLM，以比 HTML 文件更高效地处理。

llms.txt 是一种建议的标准，用于以更容易被 LLM 处理的基于文本的格式提供网页内容。您可以访问该 llms.txt 页面，通过在文档站点的根 URL 后附加 /llms.txt 。

该 llms.txt 该文件作为您文档站点的索引，提供所有可用 Markdown 格式页面的完整列表。通过此文件，您可以让 LLM 更容易高效地发现并处理您的文档内容。

当 llms.txt 文件包含您文档站点所有页面 URL 和标题的索引时， llms-full.txt 则包含您文档站点的完整内容，汇集为一个可作为上下文传递给 LLM 的文件。

LLM 可以使用此索引直接导航到页面的 Markdown 版本，允许它们将您的文档纳入其上下文，而无需解析 HTML。

既然您的 GitBook 站点会自动生成 .md 页面， llms.txt，以及 llms-full.txt 文件，这些最佳实践将帮助 LLM 有效理解并处理您的内容。

通过使用这些优化，您也可能提升文档在 AI 驱动的搜索引擎和生成引擎优化（GEO）中的表现。

最棒的是？这些指南通常也会使您的文档更易于人们阅读。

用良好的标题（H1、H2、H3）分隔内容，不要只写一大段文字。要点、编号列表和较短的段落会让一切更易阅读。

保持简单，除非非常必要，否则避免复杂的专业术语。当您直截了当地表达意思而不加赘述时，LLM 的表现会更好。

要以示例说明，而不仅仅是描述。代码片段、API 示例和真实场景有助于 LLM —— 以及您的用户 —— 理解事物在实践中的实际运作方式。

没有人喜欢过时的文档。定期更新可以避免 LLM 向人们提供有关您最新功能和更新的不准确信息。

实际尝试向 ChatGPT 或 Claude 提问有关您文档的问题，以查看它们对您内容的理解程度。您可能会对哪些有效、哪些无效感到惊讶。

最后更新于2个月前

这有帮助吗？