RTFM 测试

一种文档质量评估方法，通过创建全新的代理来验证文档是否真正可用。

问题所在

由项目开发者撰写的文档几乎总是不完整的。他们无意识地填补了空白，假设了上下文，跳过了“显然”的步骤。

RTFM 测试通过创建一个没有任何背景知识的全新代理，并提出问题：仅凭文档，你能否完成这项任务？

适用场景

• 在发布文档、README、教程或设置指南之前
• 当用户报告困惑但你无法理解原因时
• 重大重构后，验证文档是否仍然有效
• 作为文档密集型项目的持续集成（CI）一部分

工作原理

1. 明确任务 — 阅读文档后，用户应能完成什么操作？
2. 打包文档 — 收集所有相关文档（不多不少）
3. 创建新测试代理 — 使用 TESTER.md 提示词，通过 sessions_spawn 启动
4. 分析失败点 — 每一次困惑都是文档缺陷的信号
5. 修复并重复 — 更新文档，重新启动代理，反复测试直至无误

使用方式

sessions_spawn(
  task: "仅使用提供的文档完成以下任务。[任务描述]\n\n---\n\n[粘贴文档内容]",
  agentId: "default",
  label: "rtfm-test"
)

也可使用完整的 TESTER.md 提示词以获得更结构化的输出。

评估指标

• 冷启动得分 — 任务完成所需的启动周期数（越低表示文档越好）
• 缺口数量 — 每次运行中报告的 [GAP] 数量
• 缺口类别 — 缺失步骤、表述不清、错误假设、缺少前置条件

核心原则

1. 不提供提示 — 不要帮助测试代理，允许其失败
2. 字面阅读 — 测试代理不得推断或猜测
3. 仅依赖文档 — 禁止外部知识，禁止“常识”
4. 失败即信号 — 每一次卡顿都是可行动的反馈

文件清单

• SKILL.md — 本文件
• TESTER.md — 新代理的系统提示词
• GAPS.md — 输出格式规范