适用于 LLM 的文档

为你的文档站点提供一个适合 LLM 的版本

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

随着 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。

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

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

MCP 服务器

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

你可以通过在以下位置后追加 /~gitbook/mcp 到你文档站点根目录的 URL 来访问你的 MCP 服务器。例如，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 提问，看看它们对你的文档理解得有多好。你可能会对哪些有效、哪些无效感到惊讶。