桃子桃子快讯
返回首页
工具

AI Docs Standard:为智能体而写的文档规范

iwasoft 提出 AI Docs Standard,专为 LLM 与编程智能体设计的机器优先文档标准,已以 CC B…

2026.08.30 · 周日3 分钟阅读

Show HN 上出现的「AI Docs Standard」提案,主张为软件产品单独维护一份机器优先的文档文件 documentation.ai.md,供 LLM 与编程智能体读取并直接执行安装、配置与调用,而不再依赖人类文档做推断。该标准由 iwasoft 起草,采用 CC BY 4.0 许可开放。

提案核心思路

作者认为,当前的软件文档普遍面向人类读者,夹杂设计权衡与故事叙述;但 AI 智能体并不需要被「说服」,它真正需要的是端口号、环境变量名、接口响应结构等可机读、可直接执行的事实。一旦把两类内容混在一起,往往两类读者都服务不好。提案因此提出「一产品、两文档」的思路:人类文档解释 why,机器文档只陈述 what 与 how。

文件结构与采用步骤

按照规范,documentation.ai.md 应放置在产品文档目录下,与发布版本一一对应,并在每次发版时核对。文件内容按以下顺序组织:

  • identity:产品身份与定位
  • install:可一键执行的安装步骤
  • configuration:所需环境变量与配置项
  • interface quickstart:接口调用最小示例
  • admin surface:管理面入口
  • architecture facts:架构关键事实
  • links:相关链接

作者强调文档必须「自洽」:智能体仅凭这一文件即可完成安装、调用与配置,无需翻阅人类文档、源码或猜测。规范要求优先使用表格而非散文,并对每条命令保证可复制、可验证、对状态如实标注。

与 llms.txt 的关系

提案明确将 AI Docs Standard 定位为对 llms.txt 的补充而非竞争:

  • llms.txt:站点级的索引文件,列出网站可被 AI 读取的内容清单
  • documentation.ai.md:单产品、单版本的「操作手册」,颗粒度更接近 llms-full.txt

一个站点的 llms.txt 可以链接到每个产品的 documentation.ai.md,两者也可独立采用。

参考实现与现状

iwasoft 表示其自家产品(包括事件账本数据库 Kivi、S3 兼容对象存储 Vesta)已在每个版本附带符合规范的 documentation.ai.md 作为活样板。完整规范、模板与贡献流程均托管在 GitHub 仓库 iwasoftcom/ai-docs-standard,标准随社区公开演进。

截至目前,这一规范仍是单一厂商主导的社区提案,是否会被更广泛的框架或托管平台采纳,仍有待观察。

信源