dsh-learn-mode 0.1.2 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/client/client.js +452 -0
- package/cordis.patch.yml +20 -16
- package/index.js +19 -0
- package/package.json +42 -13
- package/skills/dsh-learn-mode/SKILL.md +7 -5
- package/skills/learn-synthesizer/SKILL.md +278 -0
- package/skills/learn-synthesizer/analysis/workspace-file-convention.md +402 -0
- package/skills/learn-synthesizer/evals/evals.json +72 -0
- package/skills/learn-synthesizer/references/axis-types.md +20 -0
- package/skills/learn-synthesizer/references/example-structures.md +291 -0
- package/skills/learn-synthesizer/references/feedback-types.md +296 -0
- package/skills/learn-synthesizer/references/gotchas.md +322 -0
- package/skills/learn-synthesizer/references/sub-agent-prompt.md +222 -0
- package/skills/learn-synthesizer/rules/core-principles.md +173 -0
- package/skills/learn-synthesizer/rules/output-format.md +355 -0
- package/skills/learn-synthesizer/rules/quality-gates.md +209 -0
- package/skills/learn-synthesizer/scripts/pdf_to_md.py +124 -0
- package/skills/learn-synthesizer/templates/MISSION.md +38 -0
- package/skills/learn-synthesizer/templates/deep-dive.md +73 -0
- package/skills/learn-synthesizer/templates/map-evolution.md +38 -0
- package/skills/learn-synthesizer/templates/understanding-map.md +42 -0
- package/skills/learn-synthesizer/workflows/stage0.5-mission.md +141 -0
- package/skills/learn-synthesizer/workflows/stage1-collect.md +214 -0
- package/skills/learn-synthesizer/workflows/stage2-extract.md +254 -0
- package/skills/learn-synthesizer/workflows/stage2.5-importance.md +197 -0
- package/skills/learn-synthesizer/workflows/stage3-merge.md +492 -0
- package/skills/learn-synthesizer/workflows/stage3.5-gap.md +317 -0
- package/skills/learn-synthesizer/workflows/stage4-chapter-agent.md +342 -0
- package/skills/learn-synthesizer/workflows/stage4-ref-extract.md +111 -0
- package/skills/learn-synthesizer/workflows/stage4-write.md +355 -0
- package/skills/learn-synthesizer/workflows/stage4.5-verify.md +327 -0
- package/skills/learn-synthesizer/workflows/stage5-review.md +196 -0
- package/skills/learn-synthesizer/workflows/stage5.5-iterate.md +297 -0
- package/skills/learn-synthesizer/workflows/stage6-finalize.md +310 -0
- package/skills/learn-synthesizer/workflows/stage6-progressive.md +173 -0
- package/skills-provider.mjs +99 -0
- package/workbench-host.mjs +425 -0
|
@@ -0,0 +1,297 @@
|
|
|
1
|
+
# 阶段5.5:交互式完善循环
|
|
2
|
+
|
|
3
|
+
草稿审核完成后,进入精细化打磨阶段。
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 5.5.1 用户反馈收集
|
|
8
|
+
|
|
9
|
+
主动询问用户:
|
|
10
|
+
|
|
11
|
+
> "请阅读教程并标记不清楚的地方,可以直接引用章节标题+具体段落,比如:
|
|
12
|
+
> - '3.4 临时暂存当前工作:git stash — 指令描述含糊,容易误解'
|
|
13
|
+
> - '2.1 事件循环 — 不懂为什么要这样设计'
|
|
14
|
+
>
|
|
15
|
+
> 每次可以提多条反馈,我会逐一完善。"
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## 5.5.2 反馈处理流程
|
|
20
|
+
|
|
21
|
+
**每收到一条反馈,执行以下步骤**:
|
|
22
|
+
|
|
23
|
+
### 步骤1:定位章节与段落
|
|
24
|
+
|
|
25
|
+
从用户反馈中提取:
|
|
26
|
+
- 章节编号(如"3.4")
|
|
27
|
+
- 概念名称(如"git stash")
|
|
28
|
+
- 问题描述(如"指令描述含糊")
|
|
29
|
+
|
|
30
|
+
### 步骤2:读取反馈类型识别表
|
|
31
|
+
|
|
32
|
+
**必须先读取** `references/feedback-types.md`,进行反馈类型匹配。
|
|
33
|
+
|
|
34
|
+
### 步骤3:执行对应策略
|
|
35
|
+
|
|
36
|
+
根据匹配到的反馈类型,按优先级执行:
|
|
37
|
+
|
|
38
|
+
| 优先级 | 反馈类型 | 必须操作 |
|
|
39
|
+
|-------|---------|---------|
|
|
40
|
+
| 高 | 流程复杂 | 调用 drawio MCP 绘图 |
|
|
41
|
+
| 高 | 选项参数多 | 制作参数对照表 |
|
|
42
|
+
| 中 | 术语黑话 | 增加通俗解释 |
|
|
43
|
+
| 中 | 概念抽象 | 补充使用场景或示例 |
|
|
44
|
+
| 低 | 前置知识缺 | 添加前置链接 |
|
|
45
|
+
|
|
46
|
+
**特别提醒**:
|
|
47
|
+
- **流程类反馈必须绘图**,不能用纯文字描述替代
|
|
48
|
+
- **参数表必须有"使用场景"列**,不能只列命令
|
|
49
|
+
|
|
50
|
+
### 步骤4:标注补充内容
|
|
51
|
+
|
|
52
|
+
在补充的内容前后添加注释:
|
|
53
|
+
|
|
54
|
+
```markdown
|
|
55
|
+
<!-- 补充:通俗解释 -->
|
|
56
|
+
> **通俗来说**:[内容]
|
|
57
|
+
|
|
58
|
+
<!-- 补充:流程图(阶段5.5用户反馈) -->
|
|
59
|
+
> [流程图] **流程图**:[链接]
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
在"05-参考资源.md"末尾追加补充记录:
|
|
63
|
+
|
|
64
|
+
```markdown
|
|
65
|
+
## 补充记录
|
|
66
|
+
|
|
67
|
+
### 阶段5.5 交互式完善
|
|
68
|
+
- 第3章第4节:根据用户反馈补充了 git stash 工作流程图和命令对照表(2026-06-02)
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### 步骤5:确认完成
|
|
72
|
+
|
|
73
|
+
向用户汇报:
|
|
74
|
+
|
|
75
|
+
> "已针对 [章节X.X 概念名] 补充了:
|
|
76
|
+
> - [策略1]:[具体做了什么]
|
|
77
|
+
> - [策略2]:[具体做了什么]
|
|
78
|
+
>
|
|
79
|
+
> 请查阅。还有其他需要完善的地方吗?"
|
|
80
|
+
|
|
81
|
+
---
|
|
82
|
+
|
|
83
|
+
## 5.5.3 多条反馈的批处理
|
|
84
|
+
|
|
85
|
+
如果用户一次提供了多条反馈:
|
|
86
|
+
|
|
87
|
+
### 处理顺序
|
|
88
|
+
|
|
89
|
+
按章节顺序依次处理(不打乱教程结构):
|
|
90
|
+
1. 先处理第1章的反馈
|
|
91
|
+
2. 再处理第2章的反馈
|
|
92
|
+
3. ...
|
|
93
|
+
|
|
94
|
+
### 汇报方式
|
|
95
|
+
|
|
96
|
+
每处理完一条反馈,立即汇报该条的完成情况,不等所有反馈都处理完。
|
|
97
|
+
|
|
98
|
+
**示例**:
|
|
99
|
+
|
|
100
|
+
用户反馈:
|
|
101
|
+
- "3.4 git stash 工作方式不清楚"
|
|
102
|
+
- "5.2 rebase 不懂为什么用"
|
|
103
|
+
|
|
104
|
+
处理流程:
|
|
105
|
+
1. 处理 3.4 → 绘制流程图 → 汇报"3.4 已补充流程图"
|
|
106
|
+
2. 处理 5.2 → 添加前置知识 callout → 汇报"5.2 已补充前置说明"
|
|
107
|
+
3. 最终询问:"以上2处已完善,还有其他需要改进的吗?"
|
|
108
|
+
|
|
109
|
+
---
|
|
110
|
+
|
|
111
|
+
## 5.5.4 迭代退出条件
|
|
112
|
+
|
|
113
|
+
参见 `rules/quality-gates.md` 的"迭代退出条件"章节。
|
|
114
|
+
|
|
115
|
+
### 正常退出(满足任一即停止)
|
|
116
|
+
|
|
117
|
+
1. 用户明确确认:"可以了"、"没问题了"、"很好"
|
|
118
|
+
2. 连续两轮用户回复"没有了"或反馈为空
|
|
119
|
+
3. 单个章节补充超过3轮
|
|
120
|
+
|
|
121
|
+
### 单章节超限处理
|
|
122
|
+
|
|
123
|
+
当单章节补充达到3轮时:
|
|
124
|
+
|
|
125
|
+
> "第X章已补充3轮,但您仍有疑问。这可能说明该章节内容过于复杂,建议拆分成多个子章节。是否现在重构?"
|
|
126
|
+
|
|
127
|
+
用户选择:
|
|
128
|
+
- 同意重构 → 返回阶段3,拆分该章节,重新生成
|
|
129
|
+
- 拒绝 → 继续处理下一个有反馈的章节
|
|
130
|
+
|
|
131
|
+
### 强制退出(异常情况)
|
|
132
|
+
|
|
133
|
+
- 总迭代轮次超过10轮 → 提示:"已进行10轮迭代,可能方向有问题。建议暂停,重新评估需求。"
|
|
134
|
+
- 用户连续3次反馈同一问题未解决 → 提示:"该问题3次尝试未解决,可能需要改变策略或寻求外部资源。"
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
|
|
138
|
+
## 5.5.5 特殊情况处理
|
|
139
|
+
|
|
140
|
+
### 情况1:用户反馈"内容太少"
|
|
141
|
+
|
|
142
|
+
这不属于五大反馈类型,属于**覆盖不足**问题。
|
|
143
|
+
|
|
144
|
+
处理方式:
|
|
145
|
+
1. 询问用户:"您期望该章节增加哪些内容?请具体说明。"
|
|
146
|
+
2. 根据用户描述,判断是否需要返回阶段3.5进行针对性补充搜索
|
|
147
|
+
3. 如果是已有资料中存在但未写入教程,直接补充;如果是资料中没有的内容,需要补充搜索
|
|
148
|
+
|
|
149
|
+
### 情况2:用户反馈"这部分是错的"
|
|
150
|
+
|
|
151
|
+
这属于**事实错误**,不是表达问题。
|
|
152
|
+
|
|
153
|
+
处理方式:
|
|
154
|
+
1. 立即停止,向用户确认:"您认为正确的说法是什么?或者有权威资料可以参考吗?"
|
|
155
|
+
2. 根据用户提供的正确信息或资料,修正错误内容
|
|
156
|
+
3. 在"05-参考资源.md"中记录:
|
|
157
|
+
```markdown
|
|
158
|
+
## 勘误记录
|
|
159
|
+
- 第X章第Y节:原描述错误,已根据用户反馈修正(来源:[用户提供的资料])
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### 情况3:用户反馈"写得太啰嗦"
|
|
163
|
+
|
|
164
|
+
这属于**风格问题**。
|
|
165
|
+
|
|
166
|
+
处理方式:
|
|
167
|
+
1. 询问用户:"您希望保留哪些核心内容?哪些部分可以删减?"
|
|
168
|
+
2. 根据用户指示精简内容
|
|
169
|
+
3. **不要**主动大幅删减,因为学习教程"宁多勿少"是核心原则
|
|
170
|
+
|
|
171
|
+
---
|
|
172
|
+
|
|
173
|
+
## 5.5.7 渐进深化命令(专项加深)
|
|
174
|
+
|
|
175
|
+
用户可在任意阶段输入以下格式触发专项深化:
|
|
176
|
+
|
|
177
|
+
> 请搜索相关资料,并完善【X】的内容
|
|
178
|
+
|
|
179
|
+
其中 X 可以是:章节目录名、章节文件名、或某个具体知识点名。
|
|
180
|
+
|
|
181
|
+
### 识别与解析
|
|
182
|
+
|
|
183
|
+
| X 的粒度 | 识别方法 | 深化范围 |
|
|
184
|
+
|---------|---------|---------|
|
|
185
|
+
| 目录名(如"Hooks") | 与 outline.md 中的章节组名匹配 | 该目录下所有知识点 |
|
|
186
|
+
| 文件名(如"02-核心概念.md") | 与工作区文件名匹配 | 该文件内所有知识点 |
|
|
187
|
+
| 知识点名(如"useEffect 依赖数组") | 与 importance-ratings.json 或 outline.md 中的 topic 匹配 | 仅该知识点 |
|
|
188
|
+
|
|
189
|
+
### 执行步骤
|
|
190
|
+
|
|
191
|
+
**步骤1:确认深化目标**
|
|
192
|
+
|
|
193
|
+
向用户确认:
|
|
194
|
+
> "确认要深化以下内容:[解析出的目标名](覆盖 N 个知识点)。将针对这些知识点补充搜索资料并重新撰写,是否继续?"
|
|
195
|
+
|
|
196
|
+
**步骤2:针对性补充搜索**
|
|
197
|
+
|
|
198
|
+
为每个目标知识点设计搜索关键词,聚焦:
|
|
199
|
+
- 该知识点的**难点与边界条件**(如"X 的陷阱"、"X 常见误区")
|
|
200
|
+
- 该知识点的**底层原理**(如"X 内部实现"、"X 源码解析")
|
|
201
|
+
- 该知识点的**真实场景用法**(如"X 实战案例")
|
|
202
|
+
|
|
203
|
+
每个知识点搜索 3-5 篇,派发 Sub-agent 提取,报告追加到 `_internal/02-extract/`。
|
|
204
|
+
|
|
205
|
+
**步骤3:提升重要性等级**
|
|
206
|
+
|
|
207
|
+
在 `importance-ratings.json` 中将目标知识点的 `level` 更新为 `"core"`,`depth.examples` 更新为 3。
|
|
208
|
+
|
|
209
|
+
**步骤4:按 [核心] 重新撰写**
|
|
210
|
+
|
|
211
|
+
按 `stage4-chapter-agent.md` 的"[核心]"深度指令重新撰写对应内容:
|
|
212
|
+
- 如果目标是整个章节文件:重新派发该章节的 Sub-agent,带入新的知识卡片(含深化材料)
|
|
213
|
+
- 如果目标是单个知识点:主进程直接原地修改对应段落
|
|
214
|
+
|
|
215
|
+
**步骤5:汇报完成**
|
|
216
|
+
|
|
217
|
+
> "已针对【X】补充搜索 [N] 篇资料,并按核心深度重新撰写。主要增补:
|
|
218
|
+
> - [增加了什么:原理解释 / 三层示例 / 误区说明 / 边界条件]
|
|
219
|
+
>
|
|
220
|
+
> 请查阅更新后的内容。"
|
|
221
|
+
|
|
222
|
+
### 注意事项
|
|
223
|
+
|
|
224
|
+
- 如目标知识点之前已经是 [核心]:告知用户"该知识点已是最高深度,此次主要补充最新资料",仍执行补搜和改写
|
|
225
|
+
- 单次深化不超过 10 个知识点,超出时询问用户"是否拆成多次深化?"
|
|
226
|
+
|
|
227
|
+
---
|
|
228
|
+
|
|
229
|
+
## 5.5.8 与阶段3.5的区别
|
|
230
|
+
|
|
231
|
+
| 维度 | 阶段3.5(缺口识别) | 阶段5.5(交互式完善) |
|
|
232
|
+
|------|------------------|-------------------|
|
|
233
|
+
| 触发时机 | 阶段3大纲合并后 | 阶段5人工审核后 |
|
|
234
|
+
| 问题类型 | 结构性缺失(整个主题没覆盖) | 表达性问题(写了但看不懂) |
|
|
235
|
+
| 解决方式 | 补充搜索新资料 → 重新派发 Sub-agent | 优化表达方式、绘图、补充示例 |
|
|
236
|
+
| 是否需要新资料 | 是 | 通常不需要(已有资料中有但没写清楚) |
|
|
237
|
+
|
|
238
|
+
**判断依据**:
|
|
239
|
+
- 如果用户说"没提到 X 概念" → 返回阶段3.5
|
|
240
|
+
- 如果用户说"X 概念写得看不懂" → 继续阶段5.5
|
|
241
|
+
|
|
242
|
+
---
|
|
243
|
+
|
|
244
|
+
## 5.5.9 保存会话状态
|
|
245
|
+
|
|
246
|
+
阶段5.5完成后,更新工作区的 `session-state.md`:
|
|
247
|
+
|
|
248
|
+
```markdown
|
|
249
|
+
# 会话状态
|
|
250
|
+
主题: [主题名]
|
|
251
|
+
更新时间: [当前时间]
|
|
252
|
+
学习模式: [快速参考 / 完整教程]
|
|
253
|
+
工作区: [工作区绝对路径]
|
|
254
|
+
|
|
255
|
+
---
|
|
256
|
+
|
|
257
|
+
## 进度
|
|
258
|
+
当前阶段: 5.5
|
|
259
|
+
已完成阶段: 1, 2, 3, 4, 4.5, 5
|
|
260
|
+
|
|
261
|
+
## 阶段5.5 输出
|
|
262
|
+
- 已处理反馈: [N] 条
|
|
263
|
+
- 绘图文件: [diagrams/ 下文件列表](如有)
|
|
264
|
+
- 补充标注: [M] 处
|
|
265
|
+
- 用户最终确认: 是
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
---
|
|
269
|
+
|
|
270
|
+
## 5.5.10 阶段出口门控
|
|
271
|
+
|
|
272
|
+
阶段5.5完成后,逐项检查:
|
|
273
|
+
|
|
274
|
+
- [ ] 所有用户反馈已逐一处理
|
|
275
|
+
- [ ] 流程类反馈已调用 drawio 绘图(如需要)
|
|
276
|
+
- [ ] 参数表包含"使用场景"列(如有参数类反馈)
|
|
277
|
+
- [ ] 补充内容已标注 `<!-- 补充:xxx -->`
|
|
278
|
+
- [ ] 已在"05-参考资源.md"记录补充
|
|
279
|
+
- [ ] 已向用户汇报完成情况
|
|
280
|
+
- [ ] 用户明确确认满意("可以了"/"没问题了")
|
|
281
|
+
- [ ] session-state.md 已更新(§5.5.9)
|
|
282
|
+
|
|
283
|
+
以上全部通过后,返回阶段5 §5.6,进入阶段6。
|
|
284
|
+
|
|
285
|
+
---
|
|
286
|
+
|
|
287
|
+
## 执行检查清单
|
|
288
|
+
|
|
289
|
+
每完成一条反馈处理后,自检:
|
|
290
|
+
- [ ] 已读取 `references/feedback-types.md` 进行类型匹配
|
|
291
|
+
- [ ] 流程类反馈已调用 drawio MCP 绘图
|
|
292
|
+
- [ ] 参数表包含"使用场景"列
|
|
293
|
+
- [ ] 补充内容已标注 `<!-- 补充:xxx -->`
|
|
294
|
+
- [ ] 已在"05-参考资源.md"记录补充
|
|
295
|
+
- [ ] 已向用户汇报完成情况
|
|
296
|
+
|
|
297
|
+
如果任一项为"否",补充完成后再进入下一条反馈。
|
|
@@ -0,0 +1,310 @@
|
|
|
1
|
+
# 阶段6:最终输出确认
|
|
2
|
+
|
|
3
|
+
终极教程已完成,等待用户最终通读验收。
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 6.1 向用户展示最终成果
|
|
8
|
+
|
|
9
|
+
> "终极教程已完成,输出位置:[路径]
|
|
10
|
+
>
|
|
11
|
+
> **目录概览**:
|
|
12
|
+
>
|
|
13
|
+
> [列出所有文件和章节]
|
|
14
|
+
>
|
|
15
|
+
> **统计信息**:
|
|
16
|
+
> - 学习路线图:1 份
|
|
17
|
+
> - 教程章节:N 章
|
|
18
|
+
> - 初学:X 章
|
|
19
|
+
> - 熟练:Y 章
|
|
20
|
+
> - 精通:Z 章
|
|
21
|
+
> - 示例代码:K 个
|
|
22
|
+
> - 参考资源:M 份
|
|
23
|
+
>
|
|
24
|
+
> **补充记录**(如有):
|
|
25
|
+
> - 阶段3.5补充:[补充的章节和资料]
|
|
26
|
+
> - 阶段5.5完善:[补充的流程图、参数表等]
|
|
27
|
+
>
|
|
28
|
+
> 请您通读验收。"
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## 6.2 等待用户最终验收
|
|
33
|
+
|
|
34
|
+
**重要**:最终通读由用户完成,AI 不做自我审阅(参见 `rules/core-principles.md`)。
|
|
35
|
+
|
|
36
|
+
### 用户可能的反馈
|
|
37
|
+
|
|
38
|
+
| 反馈 | 处理方式 |
|
|
39
|
+
|------|---------|
|
|
40
|
+
| "很好,没问题" | 进入 6.3 最终交付 |
|
|
41
|
+
| "还有些小问题" | 返回阶段5.5,处理用户指出的问题 |
|
|
42
|
+
| "整体需要调整" | 询问具体问题,判断是返回阶段5还是需要重新规划 |
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## 6.3 最终交付
|
|
47
|
+
|
|
48
|
+
用户验收通过后,进行最终交付:
|
|
49
|
+
|
|
50
|
+
### 步骤1:整理输出目录
|
|
51
|
+
|
|
52
|
+
确保输出目录结构清晰:
|
|
53
|
+
|
|
54
|
+
**快速参考模式**:
|
|
55
|
+
```
|
|
56
|
+
[主题]-notes.md
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
**完整教程模式**:
|
|
60
|
+
```
|
|
61
|
+
{主题}-workspace/
|
|
62
|
+
├── README.md
|
|
63
|
+
├── MISSION.md
|
|
64
|
+
├── session-state.md
|
|
65
|
+
├── understanding-map.md
|
|
66
|
+
├── _internal/ ← 构建过程产物(可删除)
|
|
67
|
+
│ ├── 01-collect/
|
|
68
|
+
│ ├── 02-extract/
|
|
69
|
+
│ ├── 03-merge/
|
|
70
|
+
│ └── 04-verify/
|
|
71
|
+
├── diagrams/ ← 图表源文件
|
|
72
|
+
└── tutorial/ ← 教程交付物(核心内容)
|
|
73
|
+
├── 00-学习路线图.md
|
|
74
|
+
├── 00-学习路线图.md
|
|
75
|
+
├── 01-基础入门.md
|
|
76
|
+
├── 02-核心概念.md
|
|
77
|
+
├── ...
|
|
78
|
+
├── 05-参考资源.md
|
|
79
|
+
├── reference/ ← 独立参考文档(阶段4.2 生成)
|
|
80
|
+
│ ├── GLOSSARY.md ← 术语表
|
|
81
|
+
│ ├── COMMANDS.md ← 命令速查表
|
|
82
|
+
│ ├── TEMPLATES.md ← 配置模板
|
|
83
|
+
│ └── TROUBLESHOOTING.md ← 常见错误速查
|
|
84
|
+
├── tutorial-examples/
|
|
85
|
+
│ ├── 01-xxx/
|
|
86
|
+
│ └── ...
|
|
87
|
+
├── diagrams/ ← 如果阶段5.5生成了流程图
|
|
88
|
+
│ ├── 03_git-stash_workflow.drawio
|
|
89
|
+
│ └── ...
|
|
90
|
+
├── MISSION.md ← 如果阶段0.5 固化了 Mission
|
|
91
|
+
└── understanding-map.md ← 阶段6 交付时初始化
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### 步骤2:生成元数据文件(可选)
|
|
95
|
+
|
|
96
|
+
在输出目录根创建 `_metadata.json`:
|
|
97
|
+
|
|
98
|
+
```json
|
|
99
|
+
{
|
|
100
|
+
"title": "[主题] 终极教程",
|
|
101
|
+
"learning_mode": "完整教程",
|
|
102
|
+
"created_at": "2026-06-02",
|
|
103
|
+
"stats": {
|
|
104
|
+
"chapters": 5,
|
|
105
|
+
"knowledge_points": 50,
|
|
106
|
+
"examples": 10,
|
|
107
|
+
"sources": 15
|
|
108
|
+
},
|
|
109
|
+
"sources": {
|
|
110
|
+
"primary": 5,
|
|
111
|
+
"secondary": 8,
|
|
112
|
+
"tertiary": 2
|
|
113
|
+
},
|
|
114
|
+
"supplements": {
|
|
115
|
+
"stage_3.5": ["主题1", "主题2"],
|
|
116
|
+
"stage_5.5": ["第3章流程图", "第5章参数表"]
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### 步骤3:清理工作区(可选)
|
|
122
|
+
|
|
123
|
+
清理过程中生成的临时文件:
|
|
124
|
+
|
|
125
|
+
```
|
|
126
|
+
工作区/
|
|
127
|
+
├── 资料清单.md ← 可保留
|
|
128
|
+
│ ├── 02-extract/ ← 可删除
|
|
129
|
+
├── outline.md ← 可保留
|
|
130
|
+
└── outline-stats.json ← 可保留
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
**建议**:保留 `_internal/01-collect/source-list.md` 和 `_internal/03-merge/outline.md`,方便后续更新教程。
|
|
134
|
+
|
|
135
|
+
---
|
|
136
|
+
|
|
137
|
+
## 6.4 向用户说明后续使用
|
|
138
|
+
|
|
139
|
+
> "终极教程已完成并交付。
|
|
140
|
+
>
|
|
141
|
+
> **使用建议**:
|
|
142
|
+
> 1. 按照"00-学习路线图.md"中的建议学习顺序阅读
|
|
143
|
+
> 2. 每个章节的示例代码(tutorial-examples/)可直接运行验证
|
|
144
|
+
> 3. 如遇不清楚的概念,可参考 diagrams/ 中的流程图
|
|
145
|
+
> 4. 深入学习时,可查阅"05-参考资源.md"中的一手资料
|
|
146
|
+
>
|
|
147
|
+
> **后续更新**:
|
|
148
|
+
> 如需更新教程(如新版本发布),可保留工作区中的 `_internal/01-collect/source-list.md` 和 `_internal/03-merge/outline.md`,补充新资料后重新执行阶段2-4。"
|
|
149
|
+
|
|
150
|
+
---
|
|
151
|
+
|
|
152
|
+
## 6.5 更新会话状态为已完成
|
|
153
|
+
|
|
154
|
+
更新工作区的 `session-state.md`,将状态标记为 `已完成`:
|
|
155
|
+
|
|
156
|
+
```markdown
|
|
157
|
+
# 会话状态
|
|
158
|
+
主题: [主题名]
|
|
159
|
+
更新时间: [当前时间]
|
|
160
|
+
学习模式: [快速参考 / 完整教程]
|
|
161
|
+
工作区: [工作区绝对路径]
|
|
162
|
+
状态: **已完成**
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
## 进度
|
|
167
|
+
当前阶段: 已完成(阶段6验收通过)
|
|
168
|
+
已完成阶段: 1, 2, 3, 4, 5, 6
|
|
169
|
+
|
|
170
|
+
## 最终输出
|
|
171
|
+
- 教程目录: [路径]
|
|
172
|
+
- 章节数: [N]章
|
|
173
|
+
- 元数据: _metadata.json(如已生成)
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
## 恢复指令
|
|
178
|
+
本次交付已完成。教程工作区已保留,可通过渐进深化模式继续迭代(参见 `workflows/stage6-progressive.md`)。
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
---
|
|
182
|
+
|
|
183
|
+
## 6.5.5 生成 README.md
|
|
184
|
+
|
|
185
|
+
在工作区根目录创建 `README.md`,按以下模板填充(用实际数据替换 `{...}` 占位符):
|
|
186
|
+
|
|
187
|
+
```markdown
|
|
188
|
+
# {主题} — 学习教程工作区
|
|
189
|
+
|
|
190
|
+
> 由 learn-synthesizer 生成 | 创建日期: {YYYY-MM-DD} | 最后更新: {YYYY-MM-DD}
|
|
191
|
+
|
|
192
|
+
## 这是什么
|
|
193
|
+
|
|
194
|
+
本工作区包含 [{主题}] 的系统学习教程。
|
|
195
|
+
Mission: {Mission.Why}
|
|
196
|
+
|
|
197
|
+
## 目录导航
|
|
198
|
+
|
|
199
|
+
| 想看什么 | 打开 |
|
|
200
|
+
|---------|------|
|
|
201
|
+
| 📖 开始学习 | [`tutorial/00-学习路线图.md`](tutorial/00-学习路线图.md) |
|
|
202
|
+
| 🎯 为什么学 | [`MISSION.md`](MISSION.md) |
|
|
203
|
+
| 📝 学习进度追踪 | [`understanding-map.md`](understanding-map.md) |
|
|
204
|
+
| 📋 术语速查 | [`tutorial/reference/GLOSSARY.md`](tutorial/reference/GLOSSARY.md) |
|
|
205
|
+
| ⌨️ 命令速查 | [`tutorial/reference/COMMANDS.md`](tutorial/reference/COMMANDS.md) |
|
|
206
|
+
| 📐 配置模板 | [`tutorial/reference/TEMPLATES.md`](tutorial/reference/TEMPLATES.md) |
|
|
207
|
+
| 🐛 常见错误 | [`tutorial/reference/TROUBLESHOOTING.md`](tutorial/reference/TROUBLESHOOTING.md) |
|
|
208
|
+
| 🗂️ 图表源文件 | [`diagrams/`](diagrams/) |
|
|
209
|
+
|
|
210
|
+
## 目录结构
|
|
211
|
+
|
|
212
|
+
- `tutorial/` — 📖 教程(从这里开始)
|
|
213
|
+
- `diagrams/` — 🗂️ 图表源文件(.drawio)
|
|
214
|
+
- `_internal/` — 🔧 构建过程产物(可安全删除)
|
|
215
|
+
- `MISSION.md` — 🎯 学习目标
|
|
216
|
+
- `understanding-map.md` — 📝 学习进度
|
|
217
|
+
|
|
218
|
+
## 渐进深化
|
|
219
|
+
|
|
220
|
+
教程不是终点——学完后可以随时回来继续:标记已掌握、深挖章节、更新版本、生成练习。
|
|
221
|
+
|
|
222
|
+
## 生成信息
|
|
223
|
+
|
|
224
|
+
- 学习模式: {快速参考/完整教程}
|
|
225
|
+
- 资料来源: {N} 份(一手 {A} / 二手 {B})
|
|
226
|
+
- 质量验证: 合格率 {X}%,教学质量均分 {X.X}/5.0
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
## 6.6 开启渐进深化模式
|
|
230
|
+
|
|
231
|
+
教程交付后,**不再结束会话**。改为初始化知识空间并提示渐进深化入口。
|
|
232
|
+
|
|
233
|
+
### 步骤1:初始化 Understanding Map
|
|
234
|
+
|
|
235
|
+
使用 `templates/understanding-map.md` 模板,在工作区创建 `understanding-map.md`。
|
|
236
|
+
|
|
237
|
+
### 步骤2:交付确认 + 渐进深化提示
|
|
238
|
+
|
|
239
|
+
```
|
|
240
|
+
教程已交付在 [工作区路径]。
|
|
241
|
+
|
|
242
|
+
这不是终点——知识空间已保留,后续你可以随时回来:
|
|
243
|
+
|
|
244
|
+
1. "我学完了第 1-3 章" → 标记已掌握,推荐后续学习路径
|
|
245
|
+
2. "第 5 章太浅了,帮我深挖" → 补充搜索,重写该章
|
|
246
|
+
3. "[主题] 出新版本了" → 增量搜索新资料,更新对应章节
|
|
247
|
+
4. "帮我生成配套练习" → 基于教程内容生成 quiz + coding exercise
|
|
248
|
+
5. "按我现在进度,推荐下一步" → 分析薄弱点,推荐优先补缺
|
|
249
|
+
6. "重新按 Mission 检查" → 重新审视 MISSION.md,移除不符合 Mission 的内容
|
|
250
|
+
|
|
251
|
+
教程可以随时回来继续,不需要从头开始。
|
|
252
|
+
|
|
253
|
+
[可选] 工作区中的 `_internal/` 目录包含构建过程的中间文件
|
|
254
|
+
(知识提取报告、验证记录、大纲草稿等),在教程交付后不再需要。
|
|
255
|
+
如希望精简工作区,可以删除 `_internal/` 整个目录。
|
|
256
|
+
需要保留的核心文件已列在 `README.md` 中。
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
详细的渐进深化命令处理流程参见 `workflows/stage6-progressive.md`。
|
|
260
|
+
|
|
261
|
+
## 常见问题
|
|
262
|
+
|
|
263
|
+
**Q1:用户说"等一段时间后再看",是否需要等待?**
|
|
264
|
+
|
|
265
|
+
A:
|
|
266
|
+
- 向用户说明:"教程已生成在 [路径],随时可以查阅。如后续有问题,欢迎再次使用本 Skill。"
|
|
267
|
+
- 任务完成,无需等待
|
|
268
|
+
|
|
269
|
+
**Q2:用户要求打包成 PDF 或其他格式,如何处理?**
|
|
270
|
+
|
|
271
|
+
A:
|
|
272
|
+
- 说明:"本 Skill 输出 Markdown 格式。如需转换为 PDF,可使用工具如 Pandoc:"
|
|
273
|
+
```bash
|
|
274
|
+
pandoc [主题]-tutorial/*.md -o [主题]-tutorial.pdf
|
|
275
|
+
```
|
|
276
|
+
- 或建议用户使用专门的文档转换 Skill
|
|
277
|
+
|
|
278
|
+
**Q3:教程生成后发现官方发布了新版本,如何更新?**
|
|
279
|
+
|
|
280
|
+
A:
|
|
281
|
+
1. 保留原有的 `_internal/01-collect/source-list.md` 和 `_internal/03-merge/outline.md`
|
|
282
|
+
2. 补充新版本的官方文档(阶段1)
|
|
283
|
+
3. 派发 Sub-agent 提取新版本知识(阶段2)
|
|
284
|
+
4. 增量合并大纲,标注新旧版本差异(阶段3)
|
|
285
|
+
5. 更新对应章节(阶段4)
|
|
286
|
+
|
|
287
|
+
**Q4:生成的教程可以分享给其他人吗?**
|
|
288
|
+
|
|
289
|
+
A:
|
|
290
|
+
- 可以,教程是用户自己的学习资料
|
|
291
|
+
- 建议在教程开头注明:"本教程由 learn-synthesizer Skill 生成,整合自以下资料:[列出来源]"
|
|
292
|
+
|
|
293
|
+
---
|
|
294
|
+
|
|
295
|
+
## 执行检查清单
|
|
296
|
+
|
|
297
|
+
完成阶段6后,自检:
|
|
298
|
+
- [ ] 已向用户展示最终成果和目录概览
|
|
299
|
+
- [ ] 等待用户最终验收(不做自我审阅)
|
|
300
|
+
- [ ] 输出目录结构清晰
|
|
301
|
+
- [ ] 元数据文件已生成(如需要)
|
|
302
|
+
- [ ] 工作区临时文件已清理(如需要)
|
|
303
|
+
- [ ] 向用户说明后续使用建议
|
|
304
|
+
- [ ] README.md 已生成并包含完整的目录导航
|
|
305
|
+
- [ ] 已向用户提示清理 `_internal/` 目录的选项
|
|
306
|
+
- [ ] 任务完成
|
|
307
|
+
|
|
308
|
+
- [ ] session-state.md 已更新为「已完成」状态
|
|
309
|
+
|
|
310
|
+
所有项目完成后,本次知识蒸馏任务结束。
|