obsidian-notes-creator

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Obsidian Notes Creator

Obsidian笔记创建指南

Transform source material into genuinely excellent study notes — with analogies that make hard things click, diagrams that show structure at a glance, and layouts that scale from a single concept to an entire subject.

将原始材料转化为真正优质的学习笔记——通过类比让晦涩概念通俗易懂，用图表直观展示结构，布局可从单个概念扩展至整个学科。

Workflow

工作流程

mermaid

flowchart LR
    A[Source Material] --> B[Understand & Extract]
    B --> C{Single topic or multi-file?}
    C -->|Single| D[Write Note]
    C -->|Multi| E[Plan Structure]
    E --> D
    D --> F[Enrich with Components]
    F --> G[Quality Check]

mermaid

flowchart LR
    A[Source Material] --> B[Understand & Extract]
    B --> C{Single topic or multi-file?}
    C -->|Single| D[Write Note]
    C -->|Multi| E[Plan Structure]
    E --> D
    D --> F[Enrich with Components]
    F --> G[Quality Check]

Step 1: Understand the Source

步骤1：理解原始材料

Read the source material and identify:

The core concepts (theory, definitions, formulas)
The mechanisms (how things work, algorithms, processes)
The tricky parts (things a student would get confused by)
Where analogies and examples would help most

The tricky parts are the most important — they're where the note earns its value.

阅读原始材料并明确：

核心概念（理论、定义、公式）
机制原理（运作方式、算法、流程）
难点部分（学生容易混淆的内容）
最适合添加类比和示例的位置

难点部分是最重要的——这正是笔记的价值所在。

Step 2: Decide Scope

步骤2：确定范围

Single note (one

.md

file) when the topic is self-contained and under ~400 lines. → Use template in

references/structure/single-note.md

Multi-file when the topic has 3+ major sub-concepts, or when sub-concepts are reused by other notes. → See rules and folder layouts in

references/structure/multi-file.md

→ Write a hub note last:

references/structure/index-note.md

当主题独立且内容少于约400行时，使用单条笔记（一个

.md

文件）。 → 参考模板：

references/structure/single-note.md

当主题包含3个及以上主要子概念，或子概念会被其他笔记复用，使用多文件模式。 → 查看规则和文件夹布局：

references/structure/multi-file.md

→ 最后编写枢纽笔记：

references/structure/index-note.md

Step 3: Write Content

步骤3：撰写内容

Order matters. Always: motivation → intuition → analogy → formal definition → confirmation. Never open with a formula. See

references/writing/intuition-first.md

For every hard concept, choose an analogy pattern: →

references/writing/analogies.md

— 5 patterns: step-down, before/after, object, pseudocode, direction-flip

For every concept, add at least one example: →

references/writing/examples.md

— Concept→Example→Variation, Problem→Solution→Why

When two things are similar, compare them immediately: →

references/writing/comparisons.md

— tables, hierarchy views, similarities + key difference

顺序至关重要。始终遵循：动机→直觉→类比→正式定义→验证的顺序。切勿以公式开篇。参考：

references/writing/intuition-first.md

针对每个晦涩概念，选择合适的类比模式： →

references/writing/analogies.md

— 5种模式：逐步拆解、前后对比、实物类比、伪代码类比、逆向类比

针对每个概念，至少添加一个示例： →

references/writing/examples.md

— 概念→示例→变体、问题→解决方案→原因

当两个内容相似时，立即进行对比： →

references/writing/comparisons.md

— 表格、层级视图、相似点+核心差异

Step 4: Add Obsidian Components

步骤4：添加Obsidian组件

Use callouts to signal special content (warnings, analogies, tips, questions) — not for decoration: →

references/components/callouts.md

— all 13 types with a decision guide

Choose the right diagram type for the content: →

references/components/diagrams.md

— Mermaid (6 types) + ASCII patterns + embedded SVG/PNG for data visuals

Fill frontmatter with tags and date: →

references/components/frontmatter.md

Link related notes with wikilinks: →

references/components/wikilinks.md

使用callouts标记特殊内容（警告、类比、提示、问题）——而非用于装饰： →

references/components/callouts.md

— 包含13种类型及决策指南

根据内容选择合适的图表类型： →

references/components/diagrams.md

— Mermaid（6种类型）+ ASCII图表模式+嵌入SVG/PNG用于数据可视化

填写包含标签和日期的frontmatter： →

references/components/frontmatter.md

使用wikilinks关联相关笔记： →

references/components/wikilinks.md

Step 5: Quality Check

步骤5：质量检查

Before finishing, run through: →

references/quality-checklist.md

Key gates: every hard concept has an analogy, every concept has an example, every note has a diagram, callouts are used purposefully, frontmatter is filled.

完成前，对照以下清单检查： →

references/quality-checklist.md

关键检查项：每个晦涩概念都有类比、每个概念都有示例、每条笔记都有图表、callouts使用有明确目的、frontmatter已填写。