@namewta/speculo 2.0.1 → 2.0.2

package/template/workflows/specdev/specdev-l-learn-change/references/lesson-format.md

@@ -1,51 +0,0 @@
-# Change 学习图解格式
-
-写图解与分配编号时读取；这是产物格式权威，不是另一套学习状态。
-
-## 输出格式
-
-在当前 change 的 `<Path>{roots.state}/specdev/changes/{change}/learning/</Path>` 内原子写入一份新的 `<Path>{roots.state}/specdev/changes/{change}/learning/{number}_{topic}.md</Path>`，并原子更新索引 `<Path>{roots.state}/specdev/changes/{change}/learning/index.md</Path>`。这些产物属于 SpecDev change，不写入 `<Path>{roots.state}/learning/</Path>`。文档必须是纯 Markdown，不生成 HTML、CSS、SVG、图片链接或浏览器专属交互。
-
-`<number>` 是两位起始、持续递增的序号：先读取索引和同目录已有的图解文件，取最大序号加一，因此第一次为 `01`，下一次为 `02`；不为旧文件重编号。`<topic>` 是主题的简短、可作文件名的标签，可使用中文、字母、数字、`-` 或 `_`，但不能含空格、`/`、`\\` 或 `..`。同主题再次解释也创建新编号文件。
-
-索引是唯一目录，使用下列 Markdown 表格；每新增一份图解就在表末追加一行，并保留既有行。文件列只写同目录的文件名：
-
-```markdown
-# Change 学习图解索引
-
-| 编号 | 文件 | 主题 | 简介 |
-| --- | --- | --- | --- |
-| 01 | 01_<topic>.md | <主题> | <一句话说明它解释什么> |
-```
-
-按主题选择最贴切的图，但优先用多个短小 ASCII 图代替长文字：
-
-```text
-结构图：
-[系统]
-  |
-  +-- [部件 A]
-  +-- [部件 B]
-
-数据流图：
-[输入] -> [处理] -> [结果]
-
-调用流图：
-[用户动作] -> [入口] -> [服务] -> [回应]
-
-状态变化图：
-[等待] -> [进行中] -> [完成]
-```
-
-每份图解至少包含以下四节：
-
-1. `## 先看全图`：一个能说清“谁和谁有关”的 ASCII 图。
-2. `## 一步一步看`：按箭头顺序解释。流程、数据或调用会移动时，再给对应的 ASCII 图。
-3. `## 术语小词典`：只保留读图必需的词。每个词先用日常语言解释，再给它的专业名字。例如：`临时便签（缓存）`，意思是“把常用结果先放在手边，下一次不用重新找”。
-4. `## 你现在能复述什么`：用短句归纳“它是什么、为什么需要它、它怎样流动或被调用”。
-
-图中的方框名称使用普通名词和动词，不用缩写；箭头必须有方向。一个图只讲一个问题。确有边界、失败或例外时，单独画一张小图说明，不把它塞进主图。
-
-## 解释依据
-
-在原四节中区分已验证事实、可定位理由、教学类比与未知；需要时用原 ASCII 图展示失败和恢复方向。旧 Spec 与实现不一致时说明差异；新理解追加编号，不改旧文件，不增加其他格式产物。