Loading...
Loading...
Compare original and translation side by side
| 用户输入特征 | 模式 | 产物 |
|---|---|---|
| "XX课程 第X章的资料/笔记/讲义",或带课程章节语境 | 课程资料模式 | 课程文件夹:MOC + 章文件(结构见 references/obsidian-format.md) |
| 课程章内的某一节/某个知识点(不整章) | 专题教程模式 | 单文件,frontmatter 标注所属课程与章节 |
| "讲透/搞懂 XX" 独立主题 | 专题教程模式 | 单文件 |
| 提供了 PPT/课件/教材片段 | 材料对齐(叠加在上述任一模式上) | 同上,但术语与符号跟材料走 |
| 整门课的资料 | 先出 MOC 大纲,经确认后逐章生成 | 文件夹 + 多章 |
| User Input Feature | Mode | Output |
|---|---|---|
| "Materials/notes/handouts for Chapter X of XX course", or with course chapter context | Course Materials Mode | Course folder: MOC + chapter files (see references/obsidian-format.md for structure) |
| A section/knowledge point within a course chapter (not the entire chapter) | Thematic Tutorial Mode | Single file, with course and chapter affiliation marked in frontmatter |
| "Thoroughly explain/understand XX" independent topic | Thematic Tutorial Mode | Single file |
| Provided PPT/courseware/textbook excerpts | Material Alignment (overlaid on any of the above modes) | Same as above, but terminology and symbols follow the provided materials |
| Materials for an entire course | First release MOC outline, generate chapter by chapter after confirmation | Folder + multiple chapters |
> [!info]> [!info]| 文件 | 何时读 |
|---|---|
| references/teaching-style.md | 动笔前——教学结构、例题规则、详尽度底线 |
| references/anti-slop.md | 动笔前——禁用词表、结构反模式、平衡条款 |
| references/obsidian-format.md | 动笔前——文件组织、callout 用途、公式与折叠语法 |
| File | When to Read |
|---|---|
| references/teaching-style.md | Before writing — teaching structure, example rules, minimum thoroughness requirements |
| references/anti-slop.md | Before writing — banned word list, structural anti-patterns, balance clauses |
| references/obsidian-format.md | Before writing — file organization, callout usage, formula and folding syntax |
python scripts/check_material.py <输出文件或目录>python scripts/check_material.py <output file or directory><输出目录>/
├── <课程名>.md # MOC / folder note:目标、章节目录、概念索引、进度
├── 第1章-章名.md # 每章一个文件
├── _考点速查.md # 可选:跨章考点与易错点索引
├── _学习进度.md # 可选:目标完成度追踪
└── 专题-主题名.md # 专题教程模式:单文件,放运行时指定目录下<Output Directory>/
├── <Course Name>.md # MOC / folder note: objectives, chapter table of contents, concept index, progress
├── Chapter 1 - [Chapter Name].md # One file per chapter
├── _Key Points Quick Reference.md # Optional: cross-chapter exam points and common mistake index
├── _Learning Progress.md # Optional: objective completion tracking
└── Thematic - [Topic Name].md # Thematic Tutorial Mode: single file, placed in the runtime-specified directory> [!info]> [!info]