面向 LLM 的文档

为你的文档站点提供 LLM 友好版本

我们正在构建一些功能，使大型语言模型（LLMs）更容易摄取并处理你的文档内容。

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

经过 LLM 优化的文档可确保像 ChatGPT、Claude、Cursor 和 Copilot 这样的 AI 系统能够检索并提供关于你的产品或 API 的准确、具有关联性的回复。

.md 页面

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

查看此页面的 .md 文件

llms.txt

llms.txt 是一项提议中的标准，旨在让网页内容以更便于 LLM 处理的基于文本的格式提供。你可以通过添加 llms.txt 页面 /llms.txt 到你文档站点的根 URL 来访问它。

该 llms.txt 文件作为你文档站点的索引，提供所有可用 markdown 格式页面的完整列表。借助这个文件，你可以让 LLM 更轻松地高效发现并处理你的文档内容。

查看 GitBook 文档的 /llms.txt

llms-full.txt

其中 llms.txt 文件包含你文档站点中所有页面 URL 和标题的索引，而 llms-full.txt 则将你文档站点的完整内容汇总到一个文件中，可作为上下文传递给 LLM。

隐藏页面也包含在 llms-full.txt中。隐藏页面只会将其从已发布的目录中移除。

查看 GitBook 文档的 /llms-full.txt 文件

LLM 可以使用这个索引直接导航到页面的 markdown 版本，使它们能够在无需解析 HTML 的情况下将你的文档纳入上下文。

MCP 服务器

GitBook 会为每个已发布的空间自动提供一个模型上下文协议（MCP）服务器。MCP 为 AI 工具提供了一种结构化方式来发现并检索你的文档作为资源——无需抓取。

隐藏页面仍可通过站点的 MCP 服务器访问。隐藏页面只会将其从已发布的目录中移除。

你的 MCP 服务器可通过在以下位置后附加 /~gitbook/mcp 来访问：文档站点根地址的 URL。例如，GitBook 文档的 MCP 服务器位于 https://gitbook.com/docs/~gitbook/mcp.

在浏览器中访问此 URL 会出现错误。相反，你可以将其分享给能够发起 HTTP 请求的工具，例如 LLM 或 IDE。

通过阅读以下内容了解更多 已发布文档的 MCP 服务器.

为 LLM 优化文档的技巧

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

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

最棒的是？这些准则通常也会让你的文档更易于人类阅读。

使用清晰的层级结构

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

撰写简洁、无行话的内容

尽量保持简单，除非确实需要，否则跳过复杂的技术术语。只要你表达的是你的意思而不加多余内容，LLM 的表现会更好。

包含实用示例

展示出来，而不只是口头描述。代码片段、API 示例和真实场景能帮助 LLM——以及你的用户——理解事物在实践中是如何运作的。

保持内容最新且准确

没人喜欢过时的文档。定期更新意味着 LLM 不会向人们提供关于你最新功能和更新的错误信息。

使用 AI 工具进行测试

实际上试着向 ChatGPT 或 Claude 提问一些关于你文档的问题，看看它们对你的内容理解得有多好。你可能会对哪些有效、哪些无效感到惊讶。