用 AI 维护文档

让 AI 写文档——然后检查它

AI 很擅长生成文档：README 段落、函数注释、API 说明。Claude Code 文档给出了一个简单的流程：先找出没有文档的地方，生成文档，然后检查并打磨。最后一步是必须的：AI 生成的文档听起来总是很有说服力——哪怕内容是错的。提交之前，先读一遍。

给 agent 看的文档：CLAUDE.md 和 AGENTS.md

如今文档有两类读者：人和 agent。CLAUDE.md 是 Claude Code 在每次 session 开始时都会读取的文件——里面写着 build 命令、代码风格规则和项目的各种特殊情况。AGENTS.md 是一个开放的、跨工具的格式，理念相同：一份“给 agent 看的 README”，已经被超过 20 款编程工具读取（截至 2026 年 7 月）。

避免文档漂移

当代码变了、却没人去改文档时，文档就会过时。错误的文档比没有文档更糟——尤其是对信任它的 agent 来说。实用的原则是：把文档更新和代码改动放进同一个改动集里，并定期问 AI：“这份 README 还符合现在的状态吗？”

给 AI 读者用的 llms.txt

如果你的文档是一个网站，一份 /llms.txt 文件会很有帮助：一份带链接的 Markdown 总览，让 AI 系统不用啃满是导航和广告的 HTML，就能找到内容。