OA0 = Omni AI 0
OA0 是一个探索 AI 的论坛
现在注册
已注册用户请  登录
OA0  ›  技能包  ›  agent-docs:创建专为 AI 智能体解析而优化的技术文档

agent-docs:创建专为 AI 智能体解析而优化的技术文档

 
  monolith ·  2026-02-23 08:38:20 · 2 次点击  · 0 条评论  

名称: agent-docs
描述: 创建专为AI智能体消费优化的文档。适用于编写SKILL.md文件、README文件、API文档或任何将被LLM在上下文窗口中阅读的文档。有助于为RAG检索、令牌效率和混合上下文层次结构组织内容。


智能体文档

编写AI智能体能够高效消费的文档。基于Vercel基准测试和行业标准(AGENTS.md, llms.txt, CLAUDE.md)。

混合上下文层次结构

为获得最佳智能体性能的三层架构:

第一层:宪法(内联)

始终保持在上下文中。 最多2,000–4,000个令牌。

# AGENTS.md
> 上下文:Next.js 16 | Tailwind | Supabase

## 🚨 关键规则
- 输出中**禁止包含**机密信息
- **仅使用** `app/` 目录

## 📚 文档索引(使用 read_file)
- 认证:`docs/auth/llms.txt`
- 数据库:`docs/db/schema.md`

包含内容:
- 安全规则、架构约束
- 构建/测试/代码检查命令(置于顶部,利用首因效应)
- 文档地图(指明更多信息的位置)

第二层:参考库(本地检索)

按需获取。 1K–5K令牌的块。

  • 框架特定指南
  • 详细的风格指南
  • API模式

第三层:研究助手(外部)

通过允许列表控制。 仅用于处理边缘情况。

  • 最新的库更新
  • 用于解决冷门错误的Stack Overflow
  • 第三方llms.txt文件

为何有效

Vercel基准测试(2026):
| 方法 | 通过率 |
|----------|-----------|
| 基于工具的检索 | 53% |
| 检索 + 提示 | 79% |
| 内联AGENTS.md | 100% |

根本原因: 元认知失败。智能体不知道它们不知道什么——它们假设训练数据是足够的。内联文档完全绕过了这个问题。

核心原则

1. 压缩索引 > 完整文档

一个8KB的压缩索引优于一个40KB的完整文档转储。

压缩为:
- 文件路径(代码所在位置)
- 函数签名(仅名称和类型)
- 否定性约束("不要使用X")

2. 为分块而结构化

RAG系统在标题处进行分割。每个部分必须自成一体:

## 数据库设置          ← 分块边界

先决条件:PostgreSQL 14+

1. 创建数据库...

规则:
- 前置关键信息(分块器会截断)
- 描述性标题(智能体通过标题文本搜索)

3. 内联优于链接

智能体无法自主浏览。每个链接 = 工具调用 + 延迟 + 潜在的失败。

方法 令牌负载 智能体成功率
完全内联 ~12K ✅ 高
仅链接 ~2K ❌ 需要获取
混合 ~4K 基础 ✅ 两者优点结合

4. "迷失在中间"问题

LLM具有U型注意力分布:
- 强: 上下文开头(首因效应)
- 强: 上下文结尾(近因效应)
- 弱: 上下文中间

解决方案: 将关键规则放在AGENTS.md的顶部。治理优先,细节在后。

5. 信噪比

剥离所有非必要内容:
- 没有"欢迎来到..."的序言
- 没有营销文本
- 核心文档中没有更新日志

像llms.txt和AGENTS.md这样的格式能机械地提高信噪比。

llms.txt 标准

为智能体准备的机器可读文档索引:

# 项目名称

> 单行项目描述。

## 认证

- [设置](docs/auth/setup.md):环境变量和初始化
- [服务器](docs/auth/server.md):Cookie处理

## 数据库

- [模式](docs/db/schema.md):完整的Prisma模式

位置: 域根目录下的 /llms.txt
配套文件: /llms-full.txt — 完整的拼接文档,已去除HTML

安全考虑

内联 = 可信

AGENTS.md是代码库的一部分。受控、版本固定。

外部 = 攻击面

  • 通过隐藏文本进行间接提示注入
  • 如果智能体可以自由浏览,存在SSRF风险
  • 依赖外部服务的正常运行时间

缓解措施: 域名允许列表,外部检索采用人在回路机制。

反面模式

  1. 粘贴50页内容 — 触发"迷失在中间"问题
  2. "参见外部文档" — 智能体无法自主浏览
  3. 通用建议 — "编写干净的代码"(应使用具体约束)
  4. 仅目录的文档 — 只有索引没有内容
  5. 仅依赖检索 — 53% 对比 100% 的通过率

高级模式

有关RAG优化、多框架文档和API模板的详细指导,请参阅 references/advanced-patterns.md

验证清单

  • [ ] 关键治理规则位于文档顶部
  • [ ] 总内联上下文少于4K令牌
  • [ ] 每个H2章节自成一体
  • [ ] 没有外部链接而不附带内联摘要
  • [ ] 否定性约束明确("不要...")
  • [ ] 提供文件路径和签名,而非完整代码
2 次点击  ∙  0 人收藏  
登录后收藏  
目前尚无回复
0 条回复
About   ·   Help   ·    
OA0 - Omni AI 0 一个探索 AI 的社区
沪ICP备2024103595号-2
Developed with Cursor