226 lines
4.2 KiB
Markdown
226 lines
4.2 KiB
Markdown
# 第N讲：标题
|
||
|
||
> 🎯 **本节目标**：一句话说明学完能做什么
|
||
|
||
## 📋 前置知识
|
||
- [[相关笔记1]] — 需要先掌握的概念
|
||
- [[相关笔记2]] — 需要先掌握的概念
|
||
|
||
---
|
||
|
||
## 🤔 为什么需要这个？
|
||
|
||
用生活场景或实际问题引出本节主题。让读者明白"为什么要学这个"。
|
||
|
||
**生活比喻**：
|
||
- 用通俗的比喻解释抽象概念
|
||
- 例如：进程 = 正在做饭的厨师
|
||
|
||
---
|
||
|
||
## 📖 核心概念
|
||
|
||
### 1. 概念一：xxx
|
||
|
||
**通俗解释**：
|
||
用简单的语言解释这个概念。
|
||
|
||
**正式定义**：
|
||
给出准确的技术定义。
|
||
|
||
**图示**：
|
||
```mermaid
|
||
graph TD
|
||
A[概念] --> B[组成部分1]
|
||
A --> C[组成部分2]
|
||
A --> D[组成部分3]
|
||
```
|
||
|
||
**对比表格**：
|
||
| 特性 | 概念A | 概念B |
|
||
|------|-------|-------|
|
||
| 特性1 | 说明 | 说明 |
|
||
| 特性2 | 说明 | 说明 |
|
||
|
||
### 2. 概念二：xxx
|
||
|
||
（同上结构）
|
||
|
||
---
|
||
|
||
## 💻 动手实践
|
||
|
||
### 示例1：xxx
|
||
|
||
```c
|
||
// 文件名.c - 简要说明
|
||
#include "wrapper.h"
|
||
|
||
int main() {
|
||
// 代码示例
|
||
// 逐行注释说明
|
||
return 0;
|
||
}
|
||
```
|
||
|
||
**编译运行**：
|
||
```bash
|
||
gcc -o 文件名 文件名.c -L. -lwrapper
|
||
./文件名
|
||
```
|
||
|
||
**预期输出**：
|
||
```
|
||
预期的输出内容
|
||
```
|
||
|
||
**关键点**：
|
||
- 解释代码的关键部分
|
||
- 说明为什么这样写
|
||
|
||
### 示例2：xxx
|
||
|
||
（同上结构）
|
||
|
||
---
|
||
|
||
## 🔗 知识关联
|
||
- 与 [[相关笔记1]] 的关系
|
||
- 与 [[相关笔记2]] 的关系
|
||
- 在操作系统整体中的位置
|
||
|
||
---
|
||
|
||
## 📝 思考题
|
||
|
||
1. **概念理解题**：用通俗的语言解释xxx概念
|
||
2. **代码分析题**：分析以下代码的输出
|
||
3. **应用题**：在什么场景下会用到xxx？
|
||
|
||
---
|
||
|
||
## 📚 扩展阅读
|
||
- 《操作系统概念》第X章：xxx
|
||
- 《深入理解计算机系统》第X章：xxx
|
||
- [相关在线资源](https://example.com)
|
||
|
||
---
|
||
|
||
## 📝 笔记使用说明
|
||
|
||
### 如何使用这个模板
|
||
|
||
1. **复制模板**：复制此文件，重命名为 `第XX讲_标题.md`
|
||
2. **填写内容**：
|
||
- 修改标题和目标
|
||
- 添加前置知识链接
|
||
- 编写"为什么需要这个"
|
||
- 解释核心概念
|
||
- 添加代码示例
|
||
- 添加思考题
|
||
3. **添加链接**：使用 `[[]]` 语法链接到相关笔记
|
||
4. **添加图表**：使用 Mermaid 语法绘制流程图、状态图等
|
||
|
||
### Mermaid 图表示例
|
||
|
||
#### 流程图
|
||
```mermaid
|
||
graph TD
|
||
A[开始] --> B[处理]
|
||
B --> C[结束]
|
||
```
|
||
|
||
#### 时序图
|
||
```mermaid
|
||
sequenceDiagram
|
||
participant A as 进程A
|
||
participant B as 进程B
|
||
A->>B: 请求
|
||
B->>A: 响应
|
||
```
|
||
|
||
#### 状态图
|
||
```mermaid
|
||
stateDiagram-v2
|
||
[*] --> 就绪
|
||
就绪 --> 运行
|
||
运行 --> 阻塞
|
||
阻塞 --> 就绪
|
||
运行 --> [*]
|
||
```
|
||
|
||
#### 甘特图
|
||
```mermaid
|
||
gantt
|
||
title 任务进度
|
||
dateFormat YYYY-MM-DD
|
||
section 任务
|
||
任务1 :a1, 2024-01-01, 7d
|
||
任务2 :after a1, 5d
|
||
```
|
||
|
||
---
|
||
|
||
## 🎨 格式规范
|
||
|
||
### 标题层级
|
||
- `#` — 一级标题（讲次标题）
|
||
- `##` — 二级标题（主要章节）
|
||
- `###` — 三级标题（子章节）
|
||
- `####` — 四级标题（细节）
|
||
|
||
### 表情符号使用
|
||
- 🎯 — 目标
|
||
- 📋 — 前置知识
|
||
- 🤔 — 问题引入
|
||
- 📖 — 核心概念
|
||
- 💻 — 动手实践
|
||
- 🔗 — 知识关联
|
||
- 📝 — 思考题/笔记
|
||
- 📚 — 扩展阅读
|
||
- ⚠️ — 注意事项
|
||
- 💡 — 提示/技巧
|
||
|
||
### 代码块
|
||
```c
|
||
// 代码示例
|
||
// 使用 ```c 标记 C 语言代码
|
||
```
|
||
|
||
```bash
|
||
# Shell 命令
|
||
# 使用 ```bash 标记 Shell 命令
|
||
```
|
||
|
||
```python
|
||
# Python 代码
|
||
# 使用 ```python 标记 Python 代码
|
||
```
|
||
|
||
### 链接
|
||
- 内部链接：`[[笔记名称]]`
|
||
- 外部链接：`[显示文本](URL)`
|
||
|
||
### 图片
|
||
```markdown
|
||
|
||
```
|
||
|
||
---
|
||
|
||
## ✅ 检查清单
|
||
|
||
完成笔记后，检查以下内容：
|
||
|
||
- [ ] 标题清晰，能准确反映内容
|
||
- [ ] 目标明确，读者知道学完能做什么
|
||
- [ ] 前置知识完整，读者知道需要先学什么
|
||
- [ ] 问题引入生动，用生活场景引出主题
|
||
- [ ] 核心概念清晰，有通俗解释和正式定义
|
||
- [ ] 图示准确，Mermaid 语法正确
|
||
- [ ] 代码示例完整，有编译运行命令
|
||
- [ ] 输出结果正确，有关键点解释
|
||
- [ ] 知识关联完整，有双向链接
|
||
- [ ] 思考题有价值，能帮助理解概念
|
||
- [ ] 扩展阅读有用，有推荐资源
|