zscole-rtfm-testing

TotalClaw 作者 totalclaw

文档质量验证方法论:孵化零上下文新智能体,检验文档是否真正可用。

安装 / 下载方式

TotalClaw CLI推荐
totalclaw install totalclaw:totalclaw~zscole-rtfm-testing
cURL直接下载,无需登录
curl -fsSL https://skills.taituai.com/api/skills/totalclaw%3Atotalclaw~zscole-rtfm-testing/file -o zscole-rtfm-testing.md
## 概述(中文)

文档质量验证方法论:孵化零上下文新智能体,检验文档是否真正可用。

## 技能正文

# RTFM 测试

一种文档质量方法论:孵化全新智能体验证文档是否真正可用。

## 问题

由构建者写的文档几乎总是不完整。他们会无意识地填补空白、假设上下文、跳过「显而易见」的步骤。

RTFM 测试通过孵化零上下文新智能体并问:仅凭文档能否完成任务?

## 何时使用

- 发布文档、README、教程或安装指南前
- 用户反馈困惑但你找不到原因时
- 大重构后验证文档仍有效时
- 作为文档密集型项目的 CI 环节

## 工作原理

1. **确定任务** — 读者读完文档后应能做什么?
2. **打包文档** — 收集所有相关文档(仅此而已)
3. **孵化测试者** — 用 TESTER.md 提示词 `sessions_spawn`
4. **分析失败** — 每个困惑点都是文档 bug
5. **修复并重测** — 更新文档、重新孵化,直到通过

## 用法

```
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 提示词获得更结构化输出。

## 指标

- **Cold Start Score** — 完成任务所需的孵化轮数(越低文档越好)
- **Gap Count** — 每次运行的 `[GAP]` 报告数
- **Gap Categories** — 缺步骤、表述不清、错误假设、缺前置条件

## 关键原则

1. **不给提示** — 不要帮测试者,让它失败。
2. **字面阅读** — 测试者不得推断或猜测
3. **仅文档** — 无外部知识、无「常识」
4. **失败即信号** — 每次卡顿都是可执行反馈

## 文件

- `SKILL.md` — 本文件
- `TESTER.md` — 新智能体系统提示词
- `GAPS.md` — 输出格式规范