SuperAPI AI 工具集

rtfm-testing

测试与质量

查看项目

更新于 10-16 07:19

技能介绍

用途:RTFM Testing 用于验证文档是否真正可用。核心假设是:由作者本人写的文档往往默认读者已具备上下文,从而省略“显而易见”的步骤。该方法让一个毫无背景的智能体只依据文档完成任务,看它能否走通。

主要能力:通过 sessions_spawn 启动零上下文的测试智能体,使用 TESTER.md 提示词进行结构化测试,记录其卡点并作为文档缺陷。指标包括冷启动分数(完成任务的 spawn 轮数,越低越好)、Gap 数量(每次运行中 [GAP] 报告数)以及 Gap 分类(缺失步骤、表述不清、错误假设、缺少前置条件)。

使用方式:先确认任务(读者读完后应能做什么),再打包相关文档(不含其他内容),然后按示例调用:sessions_spawn( task: "Complete the following task using ONLY the provided documentation. [TASK DESCRIPTION]\n\n---\n\n[PASTE DOCS HERE]", agentId: "default", label: "rtfm-test" ),分析失败点、修文档并重测,直至通过。也可使用完整 TESTER.md 提示词获得更结构化输出。

适用场景:发布文档、README、教程或安装指南之前;用户反馈困惑但作者看不出原因时;大重构后验证文档仍有效;作为文档密集型项目的 CI 环节。

限制与原则:测试中不给提示,允许失败;要求字面阅读,不允许推断或猜测;只许使用文档,不借助外部知识或“常识”;每次失败都视为可行动反馈。官方资料未提供安装命令、依赖、价格或平台信息,此处不展开。