study-notes-creator

学习笔记创建器

将源材料转化为结构化、可视化的学习笔记，并配有主题文件夹、丰富的图表和基于示例的学习内容。

工作流

flowchart LR
    A[Source Materials] --> B[Extract Topics]
    B --> C[Plan Structure]
    C --> D[Create Notes]
    D --> E[Add Diagrams + Examples]
    E --> F[Build Index]

---

步骤 1：理解源材料

1. 阅读源材料——PDF、讲义、现有文档
2. 确定 5-8 个主要主题——核心主题
3. 找出子主题——每个主题下包含哪些内容？
4. 留意适合举例的地方——哪些内容可以用真实示例来帮助理解？

---

步骤 2：规划文件夹结构

subject/
├── README.md                    # Master index
├── concepts/                    # Core theory
│   ├── 01-introduction.md
│   └── 02-fundamentals.md
├── techniques/                  # How-to procedures
│   ├── 01-method-a.md
│   └── 02-method-b.md
├── examples/                    # Worked problems
│   ├── 01-basic-examples.md
│   └── 02-advanced-examples.md
└── practice/                    # Exercises
    └── 01-exercises.md

---

步骤 3：笔记模板

# [Topic Title]

One sentence summary.

## Overview

[Mermaid diagram showing the main concept]

## Key Concepts

### Concept 1

Brief explanation.

**Example:**
[Concrete example with real-world scenario]

## Summary Table

| Term | Definition | Example |
|------|------------|---------|
| A | What A is | Real use case |

## Practice Problems

1. Problem statement
   <details>
   <summary>Solution</summary>
   Step-by-step solution
   </details>

## Related

- [[other-note]] - Connection

---

步骤 4：Mermaid 图表（首选）

流程图（流程）

flowchart LR
    A[Start] --> B[Process]
    B --> C{Decision}
    C -->|Yes| D[Action]
    C -->|No| E[End]

**适用于：**流程、决策树、算法、工作流

流程图 TB（层级／树形结构）

flowchart TB
    A[Main Topic] --> B[Branch A]
    A --> C[Branch B]
    A --> D[Branch C]
    B --> E[Detail 1]
    B --> F[Detail 2]
    C --> G[Detail 3]

**适用于：**分类体系、分类、组织结构图、主题拆解

时序图

sequenceDiagram
    participant A as Actor
    participant S as System
    A->>S: Request
    S-->>A: Response
    A->>S: Follow-up

**适用于：**交互、对话、API 调用、因果链

状态图

stateDiagram-v2
    [*] --> Idle
    Idle --> Active : Start
    Active --> Success : Complete
    Active --> Error : Fail
    Error --> Idle : Retry
    Success --> [*]

**适用于：**生命周期、状态变化、阶段、状态机

循环图

flowchart LR
    A[Stage 1] --> B[Stage 2]
    B --> C[Stage 3]
    C --> D[Stage 4]
    D --> A

**适用于：**水循环、反馈循环、迭代过程、生命周期

时间线

timeline
    title Historical Events
    1800 : Event A
    1850 : Event B
    1900 : Event C
    1950 : Event D

**适用于：**历史时间线、项目阶段、概念演变

思维导图

mindmap
  root((Topic))
    Branch A
      Detail 1
      Detail 2
    Branch B
      Detail 3
      Detail 4

**适用于：**头脑风暴、主题概览、概念关系

---

步骤 5：ASCII 图表（特殊情况）

仅在以下情况下使用 ASCII：

• 概览框，带有自定义文本布局
• 层级／堆叠图
• 比较布局

概览框

┌─────────────────────────────────────────────────────────────────────────────┐
│                              TOPIC TITLE                                    │
├─────────────────────────────────────────────────────────────────────────────┤
│                                                                             │
│  Key Point 1    Key Point 2    Key Point 3                                  │
│      │              │              │                                        │
│  [details]      [details]      [details]                                    │
│                                                                             │
└─────────────────────────────────────────────────────────────────────────────┘

层级／堆叠图

┌─────────────────────────────────────────────────────────────────────────────┐
│                              Layer 4 (Top)                                  │
├─────────────────────────────────────────────────────────────────────────────┤
│                              Layer 3                                        │
├─────────────────────────────────────────────────────────────────────────────┤
│                              Layer 2                                        │
├─────────────────────────────────────────────────────────────────────────────┤
│                              Layer 1 (Bottom)                               │
└─────────────────────────────────────────────────────────────────────────────┘

框线字符参考

Corners: ┌ ┐ └ ┘   Lines: ─ │   T-joints: ├ ┤ ┬ ┴   Arrows: ▶ ▼ ◀ ▲

---

步骤 6：基于示例的学习模式

模式 1：概念 → 示例 → 变体

## [Concept Name]

**Definition:** Brief explanation.

**Example:**
[Concrete, real-world scenario]

**Variation:**
What if [different condition]? → [Different outcome]

跨学科示例：

学科	概念	示例	变体
生物学	渗透作用	红细胞在盐水中会皱缩	在纯水中呢？→ 细胞会膨胀
经济学	供需关系	OPEC 减产时，石油价格会上涨	发现新的油田呢？→ 价格会下跌
物理学	动量	速度相同时的保龄球与网球	质量相同、速度不同呢？
历史	因果关系	工业革命 → 城市化	如果没有蒸汽机呢？

模式 2：问题 → 解决方案 → 解释

**Problem:** [Specific question]

**Solution:**
Step 1: [Action]
Step 2: [Action]
Result: [Answer]

**Why it works:** [Underlying principle]

模式 3：比较与对照

方面	主题 A	主题 B
特征 1	...	...
特征 2	...	...

**相似之处：**两者都…… **关键区别：**A 是……，而 B 是……

---

步骤 7：构建索引

# [Subject Name]

Brief description.

## Quick Navigation

### 📚 Core Concepts
- [[concepts/01-topic|Topic Name]] - Brief description

### 🔧 Techniques/Methods
- [[techniques/01-method|Method Name]] - Brief description

### 💡 Examples
- [[examples/01-basic|Basic Examples]] - Start here

---

*Last updated: YYYY-MM-DD*

---

质量检查清单

• 每篇笔记至少包含 1 个 Mermaid 图表
• 每个概念至少包含 1 个具体示例
• 示例采用真实、易于理解的情境
• 文件夹结构按阅读顺序编号
• README 链接到所有笔记
• Wiki 链接将相关主题连接起来