Skip to content

Commit 65fd3e0

Browse files
committed
Add audience fit and use cases
1 parent 7630de3 commit 65fd3e0

8 files changed

Lines changed: 238 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@
1111
<p align="center">
1212
<a href="#quickstart"><strong>Quick Start</strong></a> ·
1313
<a href="#example-output"><strong>Example Output</strong></a> ·
14+
<a href="#who-its-for"><strong>Who It's For</strong></a> ·
1415
<a href="#where-it-fits"><strong>Where It Fits</strong></a> ·
1516
<a href="./docs/bundle-format.md"><strong>Bundle Format</strong></a> ·
17+
<a href="./docs/use-cases.md"><strong>Use Cases</strong></a> ·
1618
<a href="./docs/sample-benchmark-report.md"><strong>Sample Report</strong></a> ·
1719
<a href="./ROADMAP.md"><strong>Roadmap</strong></a>
1820
</p>
@@ -36,6 +38,19 @@ Reach for it when you want to:
3638
- compare outputs across tools and models
3739
- grow toward replay and benchmark workflows
3840

41+
<a id="who-its-for"></a>
42+
43+
## Who It's For
44+
45+
![Task Bundle audience fit](./assets/audience-fit.svg)
46+
47+
This tends to resonate most with:
48+
- agent builders who want durable task artifacts instead of loose transcripts
49+
- evaluation teams that want to grow into benchmark workflows gradually
50+
- teams comparing multiple coding tools on the same starting point
51+
52+
For more concrete scenarios, see [docs/use-cases.md](./docs/use-cases.md).
53+
3954
It is not:
4055
- an agent framework
4156
- a chat UI
@@ -160,6 +175,7 @@ See:
160175
- [docs/bundle-format.zh-CN.md](./docs/bundle-format.zh-CN.md)
161176
- [docs/design-decisions.md](./docs/design-decisions.md)
162177
- [docs/replay-contract.md](./docs/replay-contract.md)
178+
- [docs/use-cases.md](./docs/use-cases.md)
163179

164180
## Five-Minute Demo
165181

README.zh-CN.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@
1111
<p align="center">
1212
<a href="#quickstart"><strong>快速开始</strong></a> ·
1313
<a href="#example-output"><strong>示例输出</strong></a> ·
14+
<a href="#who-its-for"><strong>适合谁用</strong></a> ·
1415
<a href="#where-it-fits"><strong>方案对比</strong></a> ·
1516
<a href="./docs/bundle-format.zh-CN.md"><strong>格式说明</strong></a> ·
17+
<a href="./docs/use-cases.zh-CN.md"><strong>使用场景</strong></a> ·
1618
<a href="./docs/sample-benchmark-report.zh-CN.md"><strong>示例报告</strong></a> ·
1719
<a href="./ROADMAP.zh-CN.md"><strong>路线图</strong></a>
1820
</p>
@@ -36,6 +38,19 @@ Task Bundle 是一个 TypeScript + Node.js CLI,用来把一次编码任务打
3638
- 比较不同模型或工具在同一起点上的表现
3739
- 作为未来 replay / benchmark 工作流的基础层
3840

41+
<a id="who-its-for"></a>
42+
43+
## 适合谁用
44+
45+
![Task Bundle audience fit](./assets/audience-fit.svg)
46+
47+
它通常最能打动这几类人:
48+
- 想把任务结果保存成稳定制品的 agent 作者
49+
- 想一步步积累 benchmark 工作流的评测团队
50+
- 想在同一起点上比较多个 coding 工具的团队
51+
52+
如果你想看更具体的落地方式,可以继续看 [docs/use-cases.zh-CN.md](./docs/use-cases.zh-CN.md)
53+
3954
它不打算解决这些问题:
4055
- agent 框架
4156
- 聊天 UI
@@ -160,6 +175,7 @@ task-bundle/
160175
- [docs/bundle-format.md](./docs/bundle-format.md)
161176
- [docs/design-decisions.md](./docs/design-decisions.md)
162177
- [docs/replay-contract.md](./docs/replay-contract.md)
178+
- [docs/use-cases.zh-CN.md](./docs/use-cases.zh-CN.md)
163179

164180
## 五分钟演示
165181

assets/audience-fit.svg

Lines changed: 81 additions & 0 deletions
Loading

docs/branding.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ This repository includes the visual assets used in the README and GitHub social
88
Hero image used at the top of the README.
99
- `assets/workflow-overview.svg`
1010
Workflow diagram used in the README.
11+
- `assets/audience-fit.svg`
12+
Audience card graphic used to show which teams Task Bundle is for.
1113
- `assets/quick-demo.gif`
1214
Animated terminal walkthrough for the README quick start section.
1315
- `assets/terminal-showcase.svg`

docs/branding.zh-CN.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
README 顶部使用的主视觉横幅。
99
- `assets/workflow-overview.svg`
1010
README 中使用的工作流示意图。
11+
- `assets/audience-fit.svg`
12+
README 中使用的受众卡片图,用来说明 Task Bundle 更适合哪些团队。
1113
- `assets/quick-demo.gif`
1214
README 快速开始部分使用的动图演示。
1315
- `assets/terminal-showcase.svg`

docs/use-cases.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Use Cases
2+
3+
Task Bundle is most useful when you already have real coding runs and want a lightweight way to keep them inspectable, comparable, and reusable.
4+
5+
## 1. Save a run for later review
6+
7+
If an AI coding session ends as a patch, transcript, and a half-remembered prompt, it is hard to revisit later.
8+
9+
Task Bundle gives you a stable directory with:
10+
- the original task
11+
- a short summary
12+
- event history
13+
- the resulting diff
14+
- workspace files
15+
16+
That makes it easier to review what happened a day or a month later.
17+
18+
## 2. Compare tools on the same task
19+
20+
If you want to compare Codex, Claude Code, Cursor, or an internal tool, you usually need more than screenshots.
21+
22+
Task Bundle lets you keep:
23+
- tool and model metadata
24+
- artifact hashes
25+
- outcome fields such as status and score
26+
- a comparable workspace snapshot
27+
28+
That gives `compare` and `report` something real to work with.
29+
30+
## 3. Build a benchmark collection gradually
31+
32+
Not every team wants to start by building a full benchmark platform.
33+
34+
Task Bundle works well as an intermediate step:
35+
- package runs as they happen
36+
- keep them in one directory
37+
- scan and report over the collection later
38+
39+
This is often enough to validate whether deeper benchmark tooling is even worth building.
40+
41+
## 4. Hand tasks to another teammate or tool
42+
43+
Sometimes the next step is not analysis. It is handoff.
44+
45+
Because the task, artifacts, and workspace snapshot live together, another person or tool can pick up the same bundle and continue from a clearer starting point.
46+
47+
## A Good Fit
48+
49+
Task Bundle is a good fit if:
50+
- chat logs feel too loose
51+
- zip files feel too unstructured
52+
- a full eval platform feels too heavy
53+
54+
## Not The Best Fit
55+
56+
Task Bundle is probably not the right tool if:
57+
- you need a hosted benchmark product
58+
- you need a chat interface
59+
- you need token-perfect capture of every prompt and response

docs/use-cases.zh-CN.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# 使用场景
2+
3+
Task Bundle 最适合这样的情况:你已经有真实的 AI coding 运行结果,但还不想一上来就搭完整平台,只想先把这些任务保存好、看得清、比得动、之后还能继续复用。
4+
5+
## 1. 把一次运行保存下来,之后还能看懂
6+
7+
很多 AI coding 任务最后只留下 patch、聊天记录和一点模糊印象,过几天再回头看就很难还原。
8+
9+
Task Bundle 会把这些内容整理成一个稳定目录,里面通常包括:
10+
- 原始任务
11+
- 结果摘要
12+
- 关键事件
13+
- 最终 diff
14+
- 工作区文件
15+
16+
这样后面再回看时,不用重新翻整段聊天记录。
17+
18+
## 2. 比较不同工具在同一个任务上的表现
19+
20+
如果你想比较 Codex、Claude Code、Cursor 或内部工具,光看截图通常不够。
21+
22+
Task Bundle 会把这些比较真正需要的东西留住:
23+
- 工具和模型元数据
24+
- artifact 哈希
25+
- `status``score` 这类 outcome 字段
26+
- 可以一起对照的工作区快照
27+
28+
这样 `compare``report` 才有真实内容可用。
29+
30+
## 3. 先慢慢积累 benchmark 数据,再决定要不要上平台
31+
32+
不是每个团队都适合一开始就做完整 benchmark 平台。
33+
34+
Task Bundle 更像一个中间层:
35+
- 先把真实运行结果打包下来
36+
- 放进同一个目录里管理
37+
- 之后再做扫描、汇总和排行
38+
39+
很多时候,这一步就足够帮助团队判断有没有必要继续往更重的评测系统走。
40+
41+
## 4. 把任务交给下一个人或下一个工具
42+
43+
有时候下一步不是分析,而是交接。
44+
45+
任务描述、结果文件和工作区快照都在同一个 bundle 里,另一个人或另一个工具接手时,会比只给一段聊天记录清楚得多。
46+
47+
## 适合什么情况
48+
49+
如果你觉得:
50+
- 聊天记录太散
51+
- zip 文件太糙
52+
- 完整 eval 平台太重
53+
54+
那 Task Bundle 通常会是一个合适的选择。
55+
56+
## 不太适合什么情况
57+
58+
如果你需要的是这些东西,Task Bundle 可能就不是最佳答案:
59+
- 托管式 benchmark 产品
60+
- 聊天界面
61+
- 对每一轮 prompt 和 response 做逐 token 级别的精确录制

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
"dist",
3232
"examples",
3333
"docs",
34+
"assets/audience-fit.svg",
3435
"assets/hero-banner.svg",
3536
"assets/quick-demo.gif",
3637
"assets/social-preview.svg",

0 commit comments

Comments
 (0)