Skip to content

Commit eb4f383

Browse files
committed
Improve first-run onboarding and docs
1 parent 2090003 commit eb4f383

11 files changed

Lines changed: 1031 additions & 259 deletions

README.md

Lines changed: 197 additions & 229 deletions
Large diffs are not rendered by default.

SKILL.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,22 @@ Build a Chinese-first digital double that stays local to this skill folder. Keep
1111

1212
## Quick Start
1313

14+
### Fast path for a human first run
15+
16+
If the user only wants the first visible artifact, prefer:
17+
18+
```powershell
19+
python scripts/double_builder.py start --slug my-double --display-name "我的分身"
20+
```
21+
22+
Use `correct` right after generation when the user says “我不会这么说” or “我更在意 X”:
23+
24+
```powershell
25+
python scripts/double_builder.py correct --slug my-double
26+
```
27+
28+
### Low-level path for Codex and custom workflows
29+
1430
1. Initialize a new double:
1531

1632
```powershell

docs/github-publication-kit.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
## About
77

88
```text
9-
Build a private digital double and an editable model of how you think, choose, and present yourself.
9+
Build a private digital double that captures how you judge, set boundaries, and give advice.
1010
```
1111

1212
## Topics
@@ -29,11 +29,11 @@ v0.1.0 - A local-first starting point for building a private digital double
2929
## Release Body
3030

3131
```md
32-
Not a life-log. Not a memory simulator. A local-first way to build and revise different versions of yourself.
32+
Not a life-log. Not a memory simulator. A local-first way to build and correct a self-model.
3333

34-
`create-double-skill` 的第一版聚焦一件事
34+
`create-double-skill` 现在最想解决的一件事是
3535

36-
不用自动抓取大量隐私素材,也能通过引导式提问、自由自述和显式修正,构建一个更像“你会怎么判断”的数字分身。
36+
不用自动抓取大量隐私素材,也能在几分钟内生成一个更像“你会怎么判断”的数字分身。
3737

3838
这不是人生资料库,不是记忆模拟器,也不承诺“人格复制”。
3939
它更像一个 `local-first` 的 starter repo:用结构化档案、可回写修正和可读产物,把“自我蒸馏”变成一个可迭代的工作流。
@@ -45,6 +45,9 @@ Not a life-log. Not a memory simulator. A local-first way to build and revise di
4545

4646
## This release includes
4747

48+
- 3-minute first run:`start` 命令直接提问、写入、渲染和预览
49+
- 自然语言 correction:`correct` 命令支持“我不会这么说”“我更在意 X”
50+
- `doctor` 健康检查:依赖、仓库完整性、写权限、终端编码提示
4851
- 混合采集:访谈提问和自由描述可随时切换
4952
- 固定 schema:以 `profile.yaml` 作为唯一结构化真源
5053
- 产物生成:自动渲染 `profile.md` 和运行时 `SKILL.md`
@@ -71,9 +74,7 @@ Not a life-log. Not a memory simulator. A local-first way to build and revise di
7174

7275
```powershell
7376
python -m pip install -r requirements.txt
74-
python scripts/double_builder.py init --slug my-double --display-name "我的分身"
75-
python scripts/double_builder.py apply-turn --slug my-double --payload-file examples/initial-freeform-payload.json
76-
python scripts/double_builder.py render --slug my-double
77+
python scripts/double_builder.py start --slug my-double --display-name "我的分身"
7778
```
7879

7980
Built with Codex, but not limited to Codex.

docs/release-v0.1.0.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@
2929

3030
## 本版包含
3131

32+
- 3-minute first run:`start` 命令直接提问、写入、渲染和预览
33+
- 自然语言 correction:`correct` 命令支持“我不会这么说”“我更在意 X”
34+
- `doctor` 健康检查:依赖、仓库完整性、写权限、终端编码提示
3235
- 混合采集:访谈提问和自由描述可随时切换
3336
- 固定 schema:以 `profile.yaml` 作为唯一结构化真源
3437
- 产物生成:自动渲染 `profile.md` 和运行时 `SKILL.md`
@@ -53,9 +56,7 @@
5356

5457
```powershell
5558
python -m pip install -r requirements.txt
56-
python scripts/double_builder.py init --slug my-double --display-name "我的分身"
57-
python scripts/double_builder.py apply-turn --slug my-double --payload-file examples/initial-freeform-payload.json
58-
python scripts/double_builder.py render --slug my-double
59+
python scripts/double_builder.py start --slug my-double --display-name "我的分身"
5960
```
6061

6162
## 公开发布前建议

examples/README.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,30 @@
11
# create-double-skill examples
22

3-
这个目录放的是“可直接拿来参考”的结构化 payload。
3+
如果你是第一次来到这个仓库,先不要从 payload 开始
44

5-
推荐顺序
5+
优先顺序建议
66

7-
1. 先看 `initial-freeform-payload.json`
8-
2. 再看 `correction-payload.json`
9-
3. 用你自己的原始回答替换其中的文本
10-
4. 通过 `apply-turn` 合并,再运行 `render`
7+
1. 先用 `python scripts/double_builder.py start --slug my-double --display-name "我的分身"` 跑通第一次成功
8+
2. 再看 [start-transcript.md](start-transcript.md),确认交互大概长什么样
9+
3. 再看 [generated-artifacts.md](generated-artifacts.md),确认产物长什么样
10+
4. 最后才看低层 payload 示例
1111

12-
## 最短演示流程
12+
## First-Run Assets
13+
14+
- [start-transcript.md](start-transcript.md)
15+
- [generated-artifacts.md](generated-artifacts.md)
16+
- [correction-before-after.md](correction-before-after.md)
17+
18+
这些示例对应的是“陌生用户第一次来到仓库,如何在 3 分钟内完成第一次成功”。
19+
20+
## Advanced Payload Examples
21+
22+
如果你在做高级用法、Codex 工作流、或自定义 patch,再看这些:
23+
24+
- [initial-freeform-payload.json](initial-freeform-payload.json)
25+
- [correction-payload.json](correction-payload.json)
26+
27+
最短低层流程:
1328

1429
```powershell
1530
python scripts/double_builder.py init --slug demo --display-name "演示分身"
@@ -19,8 +34,9 @@ python scripts/double_builder.py apply-turn --slug demo --payload-file examples/
1934
python scripts/double_builder.py render --slug demo
2035
```
2136

22-
## 说明
37+
## Notes
2338

24-
- 这些 payload 是演示格式,不是“唯一正确答案”
39+
- 这些 payload 是低层接口示例,不是第一次使用者的主入口
2540
- 最好的 payload 应该尽量小、尽量准
2641
- 如果一句话还不能确定,就先放进 `unknowns`
42+
- canonical truth 仍然是 `profile.yaml`,不是这些 JSON 示例本身
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# correction before / after
2+
3+
`create-double-skill` 的灵魂不是“一次生成”,而是“生成后能改”。
4+
5+
下面是一个极简例子。
6+
7+
## before
8+
9+
```md
10+
## Signature Phrases
11+
Tentative:
12+
- 你应该先冷静一下
13+
```
14+
15+
## user correction
16+
17+
```text
18+
我不会直接说“你应该”,我更常说“如果是我,我会先把边界讲清楚”。
19+
```
20+
21+
## after
22+
23+
```md
24+
## Taboo Phrases
25+
Confirmed:
26+
- 你应该
27+
28+
## Signature Phrases
29+
Confirmed:
30+
- 如果是我,我会先把边界讲清楚
31+
```
32+
33+
这种 correction 会同时做三件事:
34+
35+
- 把原句记进 `corrections`
36+
- 把更像你的表达回写到结构化字段
37+
- 重新渲染 `profile.md``SKILL.md`

examples/generated-artifacts.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# generated artifacts
2+
3+
`start` 跑完之后,你至少会看到这三类产物:
4+
5+
## 1. Canonical truth: `profile.yaml`
6+
7+
```yaml
8+
values:
9+
priorities:
10+
- text: 长期可持续
11+
source: direct
12+
- text: 关系里的稳定感
13+
source: direct
14+
decision_model:
15+
default_questions:
16+
- text: 我会先问这件事三个月后还重要吗
17+
source: direct
18+
interaction_style:
19+
boundary_style:
20+
- text: 我会把底线讲清楚,但尽量不把气氛推到最糟
21+
source: direct
22+
```
23+
24+
## 2. Human-readable snapshot: `profile.md`
25+
26+
```md
27+
## Priorities
28+
Confirmed:
29+
- 长期可持续
30+
- 关系里的稳定感
31+
32+
## Default Questions
33+
Confirmed:
34+
- 我会先问这件事三个月后还重要吗
35+
36+
## Boundary Style
37+
Confirmed:
38+
- 我会把底线讲清楚,但尽量不把气氛推到最糟
39+
```
40+
41+
## 3. Runtime double: `SKILL.md`
42+
43+
```md
44+
## Confirmed Material
45+
46+
- 优先级: 长期可持续;关系里的稳定感
47+
- 先问的问题: 我会先问这件事三个月后还重要吗
48+
- 设边界的方式: 我会把底线讲清楚,但尽量不把气氛推到最糟
49+
```
50+
51+
first success 的目标不是“字段填满”,而是先得到一个足够真实、可继续修正的第一版。

examples/start-transcript.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# start transcript
2+
3+
下面是一段更接近真实 first run 的交互示例。
4+
5+
```text
6+
$ python scripts/double_builder.py start --slug my-double --display-name "我的分身"
7+
3 分钟内生成你的第一个 double,不需要写 JSON。
8+
9+
1/3 你做重要决定时,通常先保护什么?
10+
> 长期可持续、关系里的稳定感
11+
12+
2/3 别人来找你要建议时,你通常会先问什么,或先看什么?
13+
> 我会先问这件事三个月后还重要吗
14+
15+
3/3 你不舒服时会怎么设边界?
16+
> 我会把底线讲清楚,但尽量不把气氛推到最糟
17+
18+
已生成:
19+
- doubles/my-double/profile.md
20+
- doubles/my-double/SKILL.md
21+
22+
当前 preview:
23+
- 优先保护:长期可持续;关系里的稳定感
24+
- 给建议前先问:我会先问这件事三个月后还重要吗
25+
- 设边界方式:我会把底线讲清楚,但尽量不把气氛推到最糟
26+
- 下一步:别人低落或混乱时,你更像是安抚、追问,还是帮对方看清取舍?
27+
28+
如果有一句不对,直接输入“我不会这么说...”或“我更在意...”,回车跳过:
29+
> 我更在意边界清晰
30+
```
31+
32+
这个 first run 刻意把重点放在:
33+
34+
- 取舍顺序
35+
- 默认提问方式
36+
- 边界风格
37+
38+
而不是先让你写一堆 biography。

0 commit comments

Comments
 (0)