智能体文档规范

技能简介

agent-docs 提供一套面向 AI 智能体消费的技术文档编写规范，基于 Vercel 基准测试与行业标准（AGENTS.md、llms.txt、CLAUDE.md），帮助开发者构建适合大语言模型上下文窗口的文档结构。

能做什么

• 设计三层混合上下文架构（Constitution/Inline + Reference Library + Research Assistant）
• 优化文档分块策略，提升 RAG 检索准确率
• 压缩文档体积，平衡信息密度与 Token 消耗
• 规避”中间遗忘”问题，合理排布关键规则位置
• 生成机器可读的 llms.txt 标准索引文件

使用说明

安装：无需安装，直接参考规范编写文档。

使用步骤：

1. 创建项目根目录 AGENTS.md，控制 2000-4000 Token 以内
2. 顶部放置安全规则与架构约束（利用首因效应）
3. 列出构建/测试/ lint 命令及文档地图
4. 详细内容拆分为 1K-5K Token 的本地引用库
5. 外部资源通过白名单控制，人工介入把关
6. 验证清单：关键治理置顶、总内联上下文低于 4K Token、各 H2 自包含、无纯链接、显式否定约束

输入与输出

见下方输入与输出表格。

风险提示

• 外部链接存在间接提示注入与 SSRF 风险，需配置域名白名单
• 过度依赖检索而非内联文档，智能体通过率从 100% 降至 53%
• 粘贴 50 页以上文档会触发”中间遗忘”效应
• 通用建议（如”写整洁代码”）对智能体无实际指导价值

来源信息

原始链接：https://github.com/openclaw/skills/tree/main/skills/tylervovan/agent-docs/SKILL.md
来源类型：GitHub 技能仓库