Back to Details

study-notes-creator

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Study Notes Creator

学习笔记创建工具

Transform source materials into organized, visual study notes with themed folders, rich diagrams, and example-based learning.
将源材料转换为具备主题文件夹、丰富图表和基于示例学习的有条理的可视化学习笔记。

Workflow

工作流

mermaid
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]
mermaid
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]

Step 1: Understand the Source

步骤1：理解源材料

  1. Read the source - PDFs, lecture notes, existing docs
  2. Identify 5-8 main topics - Major themes
  3. Find subtopics - What falls under each theme?
  4. Note example opportunities - Where can real examples help?
  1. 阅读源材料 - PDF、讲义、现有文档
  2. 确定5-8个主要主题 - 核心主题
  3. 梳理子主题 - 每个主题下包含哪些内容？
  4. 标记示例机会 - 哪些地方可以用实际示例辅助理解？

Step 2: Plan Folder Structure

步骤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
subject/
├── README.md                    # 主索引
├── concepts/                    # 核心理论
│   ├── 01-introduction.md
│   └── 02-fundamentals.md
├── techniques/                  # 操作流程
│   ├── 01-method-a.md
│   └── 02-method-b.md
├── examples/                    # 实例练习
│   ├── 01-basic-examples.md
│   └── 02-advanced-examples.md
└── practice/                    # 练习题
    └── 01-exercises.md

Step 3: Note Template

步骤3：笔记模板

markdown
undefined
markdown
undefined

[Topic Title]

[主题标题]

One sentence summary.
一句话总结。

Overview

概述

[Mermaid diagram showing the main concept]
[展示核心概念的Mermaid图表]

Key Concepts

关键概念

Concept 1

概念1

Brief explanation.
Example: [Concrete example with real-world scenario]
简要说明。
示例： [结合真实场景的具体案例]

Summary Table

总结表格

TermDefinitionExample
AWhat A isReal use case
术语定义示例
AA的含义实际用例

Practice Problems

练习题

  1. Problem statement <details> <summary>Solution</summary> Step-by-step solution </details>
  1. 题目描述 <details> <summary>解答</summary> 分步解决方案 </details>

Related

相关内容

  • [[other-note]] - Connection

---
  • [[other-note]] - 关联链接

---

Step 4: Mermaid Diagrams (Primary)

步骤4：Mermaid图表（首选）

Flowchart (Process Flow)

流程图（流程逻辑）

mermaid
flowchart LR
    A[Start] --> B[Process]
    B --> C{Decision}
    C -->|Yes| D[Action]
    C -->|No| E[End]
Use for: Processes, decision trees, algorithms, workflows
mermaid
flowchart LR
    A[Start] --> B[Process]
    B --> C{Decision}
    C -->|Yes| D[Action]
    C -->|No| E[End]
适用场景： 流程、决策树、算法、工作流

Flowchart TB (Hierarchy/Tree)

纵向流程图（层级/树形结构）

mermaid
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]
Use for: Taxonomies, classifications, org charts, topic breakdowns
mermaid
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]
适用场景： 分类体系、组织结构、主题拆分

Sequence Diagram

序列图

mermaid
sequenceDiagram
    participant A as Actor
    participant S as System
    A->>S: Request
    S-->>A: Response
    A->>S: Follow-up
Use for: Interactions, conversations, API calls, cause-effect chains
mermaid
sequenceDiagram
    participant A as Actor
    participant S as System
    A->>S: Request
    S-->>A: Response
    A->>S: Follow-up
适用场景： 交互流程、对话、API调用、因果链

State Diagram

状态图

mermaid
stateDiagram-v2
    [*] --> Idle
    Idle --> Active : Start
    Active --> Success : Complete
    Active --> Error : Fail
    Error --> Idle : Retry
    Success --> [*]
Use for: Lifecycles, status changes, phases, state machines
mermaid
stateDiagram-v2
    [*] --> Idle
    Idle --> Active : Start
    Active --> Success : Complete
    Active --> Error : Fail
    Error --> Idle : Retry
    Success --> [*]
适用场景： 生命周期、状态变化、阶段流程、状态机

Cycle Diagram

循环图

mermaid
flowchart LR
    A[Stage 1] --> B[Stage 2]
    B --> C[Stage 3]
    C --> D[Stage 4]
    D --> A
Use for: Water cycle, feedback loops, iterative processes, life cycles
mermaid
flowchart LR
    A[Stage 1] --> B[Stage 2]
    B --> C[Stage 3]
    C --> D[Stage 4]
    D --> A
适用场景： 水循环、反馈循环、迭代流程、生命周期

Timeline

时间线

mermaid
timeline
    title Historical Events
    1800 : Event A
    1850 : Event B
    1900 : Event C
    1950 : Event D
Use for: Historical timelines, project phases, evolution of concepts
mermaid
timeline
    title Historical Events
    1800 : Event A
    1850 : Event B
    1900 : Event C
    1950 : Event D
适用场景： 历史时间线、项目阶段、概念演变

Mind Map

思维导图

mermaid
mindmap
  root((Topic))
    Branch A
      Detail 1
      Detail 2
    Branch B
      Detail 3
      Detail 4
Use for: Brainstorming, topic overviews, concept relationships
mermaid
mindmap
  root((Topic))
    Branch A
      Detail 1
      Detail 2
    Branch B
      Detail 3
      Detail 4
适用场景： 头脑风暴、主题概述、概念关联

Step 5: ASCII Diagrams (Edge Cases)

步骤5：ASCII图表（边缘场景）

Use ASCII only for:
  • Overview boxes with custom text layout
  • Layer/stack diagrams
  • Comparison layouts
仅在以下场景使用ASCII图表：
  • 自定义文本布局的概览框
  • 层级/堆叠图
  • 对比布局

Overview Box

概览框

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

Layers/Stack

层级/堆叠图

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

Box Characters Reference

框形字符参考

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

Step 6: Example-Based Learning Patterns

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

Pattern 1: Concept → Example → Variation

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

markdown
undefined
markdown
undefined

[Concept Name]

[概念名称]

Definition: Brief explanation.
Example: [Concrete, real-world scenario]
Variation: What if [different condition]? → [Different outcome]

**Cross-discipline examples:**

| Subject | Concept | Example | Variation |
|---------|---------|---------|-----------|
| Biology | Osmosis | Red blood cells in salt water shrink | In pure water? → Cells swell |
| Economics | Supply/Demand | Oil price rises when OPEC cuts production | New oil discovered? → Price falls |
| Physics | Momentum | Bowling ball vs tennis ball at same speed | Same mass, different speed? |
| History | Cause/Effect | Industrial Revolution → urbanization | No steam engine? |
定义： 简要说明。
示例： [具体的真实场景]
变体： 如果[条件变化]会怎样？→ [不同结果]

**跨学科示例：**

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

Pattern 2: Problem → Solution → Explanation

模式2：问题→解决方案→原理说明

markdown
**Problem:** [Specific question]

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

**Why it works:** [Underlying principle]
markdown
**问题：** [具体问题]

**解决方案：**
步骤1：[操作]
步骤2：[操作]
结果：[答案]

**原理：** [底层逻辑]

Pattern 3: Compare and Contrast

模式3：对比分析

AspectTopic ATopic B
Feature 1......
Feature 2......
Similarities: Both... Key Difference: A is... while B is...
维度主题A主题B
特征1......
特征2......
相似点： 两者均... 核心差异： A是...而B是...

Step 7: Build the Index

步骤7：构建索引

markdown
undefined
markdown
undefined

[Subject Name]

[学科名称]

Brief description.
简要说明。

Quick Navigation

快速导航

📚 Core Concepts

📚 核心概念

  • [[concepts/01-topic|Topic Name]] - Brief description
  • [[concepts/01-topic|主题名称]] - 简要说明

🔧 Techniques/Methods

🔧 操作方法

  • [[techniques/01-method|Method Name]] - Brief description
  • [[techniques/01-method|方法名称]] - 简要说明

💡 Examples

💡 示例

  • [[examples/01-basic|Basic Examples]] - Start here
Last updated: YYYY-MM-DD

---
  • [[examples/01-basic|基础示例]] - 入门首选
最后更新：YYYY-MM-DD

---

Quality Checklist

质量检查清单

  • Every note has at least 1 Mermaid diagram
  • Every concept has at least 1 concrete example
  • Examples use real, relatable scenarios
  • Folder structure is numbered for reading order
  • README links to all notes
  • Wikilinks connect related topics
  • 每篇笔记至少包含1个Mermaid图表
  • 每个概念至少包含1个具体示例
  • 示例采用真实、贴近生活的场景
  • 文件夹结构按编号排序，方便阅读
  • README文件链接到所有笔记
  • 使用维基链接关联相关主题