学习笔记创建者
- 作者仓库星标 17
- 作者仓库 vibe-study-skills
- 领域
- 文档
- 作者声明的智能体
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 88 / 100 · 启发式扫描,不代表运行安全
- 运行环境证据
- 未执行;当前没有隔离运行测试证据
- 作者 / 版本 / 许可证
- @szeyu · 未声明许可证
- 上下文用量评级
- 低消耗
- 接入复杂程度
- 即装即用
- 是否需要外部接口密钥
- 不需要
- 兼容的系统
- 未声明(默认跨平台)
- 运行环境要求
- 未检出明确要求
- 检测到的文件与系统行为
-
- 只读
- 允许写入 / 修改
- 网络行为
- 仅限本地
- 安装命令数
- 无(仅作为资料)
需要注意: 未声明工具权限范围;实际权限由运行环境决定。
第 1 步:了解来源
阅读源代码 - PDF、讲义、现有文档 确定 5-8 个主要主题 - 主要主题 查找子主题 - 每个主题下包含哪些内容?注意示例机会 - 真实示例可以在哪些方面提供帮助?
第 5 步:ASCII 图(边缘情况)
仅将 ASCII 用于: 具有自定义文本布局的概述框 层/堆栈图 比较布局
# 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]
```
---
## Step 1: Understand the Source
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?
---
## Step 2: Plan Folder Structure
```
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
```
---
## Step 3: Note Template
```markdown
# [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
```
---
## Step 4: Mermaid Diagrams (Primary)
### 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
### 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
### 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
### 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
### 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
### 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
### 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
---
## Step 5: ASCII Diagrams (Edge Cases)
Use ASCII only for:
- **Overview boxes** with custom text layout
- **Layer/stack diagrams**
- **Comparison layouts**
### Overview Box
```
┌─────────────────────────────────────────────────────────────────────────────┐
│ 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) │
└─────────────────────────────────────────────────────────────────────────────┘
```
### Box Characters Reference
```
Corners: ┌ ┐ └ ┘ Lines: ─ │ T-joints: ├ ┤ ┬ ┴ Arrows: ▶ ▼ ◀ ▲
```
---
## Step 6: Example-Based Learning Patterns
### Pattern 1: Concept → Example → Variation
```markdown
## [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
```markdown
**Problem:** [Specific question]
**Solution:**
Step 1: [Action]
Step 2: [Action]
Result: [Answer]
**Why it works:** [Underlying principle]
```
### Pattern 3: Compare and Contrast
| Aspect | Topic A | Topic B |
|--------|---------|---------|
| Feature 1 | ... | ... |
| Feature 2 | ... | ... |
**Similarities:** Both...
**Key Difference:** A is... while B is...
---
## Step 7: Build the Index
```markdown
# [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*
```
---
## 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 步:了解来源
流程图(工艺流程)
流程图 TB(层次结构/树)
时序图
状态图
文件/命令 -> README.md · 01-introduction.md · 02-fundamentals.md · 01-method-a.md · 02-method-b.md · 01-basic-examples.md · 02-advanced-examples.md · 01-exercises.md
内容校验值 -> 80b977ef1d75
当前原文的自动摘译,尚未人工审校。
流程图(工艺流程)
用于:流程、决策树、算法、工作流程
流程图 TB(层次结构/树)
用于:分类、分类、组织结构图、主题细分
时序图
用于:交互、对话、API 调用、因果链
状态图
用于:生命周期、状态更改、阶段、状态机