在LLMs成为读者的世界中编写文档
Source: Dev.to
翻译请求
请提供您希望翻译的完整文本（文章正文），我将为您把它翻译成简体中文，并保留原始的 Markdown 格式、代码块和链接不变。谢谢！
1. Google Cloud 如何为 AI 调整文档
Google Cloud 开发者体验团队专注于一个目标：帮助开发者尽快从学习转向上线。
随着 Google Cloud 服务的增长，保持文档的准确性和时效性变得更加困难。开发者期望快速、正确的答案。如果文档落后，采纳率会受到影响。
Google Cloud 并没有取代技术写作者——他们使用 AI 对其进行增强。
Generative AI is now part of their documentation workflow. 它帮助进行格式化、标记翻译和验证。有些文档甚至通过在真实环境中运行文档中的步骤自动进行测试。
文档被视为代码：生成、测试并持续改进。
你可能并未在 Google Cloud 那样的大规模工作，但同样的压力已经在许多团队中出现。
2. 文档不再仅供人类阅读
开发者仍然会阅读文档，但很多情况下，AI 会先阅读。
如今，开发者：
- 请求 AI 生成并调试代码
- 让 AI 调研 API 和工具
- 将完整的文档页面粘贴到提示中
人类读者仍然重要，但大型语言模型现在已成为文档的主要消费方。这一现实改变了文档的结构和发布方式。
3. 技术写作者不与 AI 竞争，他们是 AI 的赋能者。
担心 AI 会取代技术写作者是很容易的想法，但实际情况恰恰相反。
AI 能够快速生成文本，却无法决定哪些内容重要、哪些是正确的，或者概念应该如何组织。技术写作者提供了这种结构。
技术写作者不需要与 AI 竞争；他们需要组织知识，使 AI 能够正确使用这些知识。这一转变把角色从“写页面”转向“设计知识系统”。
一种常见的做法是为 AI 工具提供结构化、机器可读的文档版本。这正是 llms.txt 所发挥的作用。
4. llms.txt 是什么以及它不是什麼
llms.txt 是您文档的机器可读版本。它通常使用 Markdown 编写，旨在供 AI 工具和大型语言模型（LLM）使用。
可以把它看作一个翻译层：
- 您的主文档保持对人类友好
llms.txt为 AI 提供同一内容的清晰结构化视图
一个好的 llms.txt 文件通常包括：
- 核心概念和术语
- API 概览和约束
- 身份验证和环境假设
- 规范示例
- 已知的局限性和边缘情况
它 不是 文档的替代品，而是对文档的保护。通过为 AI 提供专属的上下文文件，您可以避免将面向人类的文档转变为仅适用于提示的内容。人类读者获得清晰度；AI 工具获得结构化信息。
5. 让 llms.txt 自动生成
Google Cloud 的一个关键经验是自动化。他们的文档是持续生成、验证和测试的。llms.txt 也应遵循同样的思路。
最佳实践： 每当文档发生变化时自动生成它。
实际操作指南：
- 将
llms.txt作为文档构建过程的一部分生成 - 在每次文档编辑时重新生成
- 保持 Markdown 中的标题、代码块、链接和示例不变
- 添加简单的检查，以确保文件完整
为何这很重要：
- AI 依赖最新的上下文
- 手动更新会随时间漂移
- 自动化让人类与 AI 保持一致
一个真相来源。两类受众。无需重复。
6. Google Cloud AI 代码系统的经验教训
Google Cloud 也将 AI 应用于代码示例。他们面对成千上万的 API、众多语言以及持续的变化。手动维护根本无法扩展。
他们的解决方案使用了 AI 系统，能够：
- 从官方 API 定义生成示例
- 自动审查并完善结果
- 在发布前对代码进行测试
这个教训很简单：当知识是结构化的、基于事实的并且经过验证时，AI 的效果最佳。同样的原则也适用于文档。llms.txt 为 AI 工具提供了这种结构。
7. 如何在实践中使用 llms.txt
对于功能受限、无法自行获取文档的 AI 工具，llms.txt 尤其有用。
一个简单的工作流程：
- 打开
docs.example.com/llms.txt - 下载或复制该 Markdown 文件
- 将其上传到你的 AI 编码工具中
- 让工具在此上下文下进行分析、调试或生成代码
这可以让 AI 输出与真实文档和实际约束保持一致。
8. 让它易于查找
为了让 llms.txt 有用，它必须是可见的。
推荐做法：
- 在
docs.example.com/llms.txt上发布它 - 保持 Markdown 格式
- 在文档中添加一个可见的按钮，例如 “AI Context (llms.txt)”，并在新标签页中打开它
这不是高级用户的技巧；它是基本的文档基础设施。
9. 结束语
AI 并没有消除技术写作者的需求；它提升了期望值。工作从写更多页面转向：
- 清晰地组织知识
- 设计可扩展的系统
- 让文档对人类和机器都可靠
llms.txtllms.txt 是一个小文件，但它代表了真正的转变。如果你今天负责文档，问题不在于 AI 是否会阅读它——它已经在阅读。真正的问题是它是否在阅读正确的版本。