可读性技巧 #
概述 #
提高 Markdown 文档的可读性,让读者更容易理解和吸收内容。
结构清晰 #
使用标题层级 #
markdown
好的:
## 主要内容
### 子内容
#### 详细说明
不好的:
## 内容
## 内容
## 内容(同级标题过多)
添加目录 #
markdown
## 目录
- [简介](#简介)
- [安装](#安装)
- [使用](#使用)
使用分割线 #
markdown
## 章节1
内容...
---
## 章节2
内容...
内容组织 #
使用列表 #
markdown
好的:
## 功能特性
- 特性一:说明
- 特性二:说明
- 特性三:说明
不好的:
## 功能特性
特性一说明。特性二说明。特性三说明。
使用表格对比 #
markdown
好的:
| 方案 | 优点 | 缺点 |
|------|------|------|
| A | 快 | 贵 |
| B | 慢 | 便宜 |
不好的:
方案A优点是快,缺点是贵。方案B优点是便宜,缺点是慢。
使用引用突出 #
markdown
好的:
> **重要提示**:这是一个关键信息。
不好的:
这是一个关键信息。
视觉层次 #
使用强调 #
markdown
好的:
这是一个**重要**的概念,需要*特别注意*。
不好的:
这是一个重要的概念,需要特别注意。
使用代码高亮 #
markdown
好的:
使用 `npm install` 安装依赖
不好的:
使用 npm install 安装依赖
使用图片说明 #
markdown
好的:

*图:系统流程图*
不好的:

段落写作 #
短段落 #
markdown
好的:
这是一个短段落。
这是另一个短段落。
不好的:
这是一个非常长的段落,包含多个观点,读者容易疲劳...
首句概括 #
markdown
好的:
Markdown 是一种轻量级标记语言。它使用简单的语法...
不好的:
在2004年,John Gruber 创建了一种语言...
使用过渡词 #
markdown
好的:
首先,安装依赖。然后,配置项目。最后,运行项目。
不好的:
安装依赖。配置项目。运行项目。
代码展示 #
添加注释 #
markdown
好的:
```javascript
// 获取用户信息
const user = await fetchUser(id);
// 处理数据
const processed = processData(user);
// 返回结果
return processed;
不好的:
javascript
const user = await fetchUser(id);
const processed = processData(user);
return processed;
text
### 分步说明
```markdown
好的:
## 步骤一:安装
```bash
npm install
步骤二:配置 #
javascript
module.exports = { ... };
不好的:
bash
npm install
javascript
module.exports = { ... };
(无分步说明)
text
## 提示框
### 使用引用样式
```markdown
> **提示**:这是一个提示信息。
> **注意**:这是一个注意事项。
> **警告**:这是一个警告信息。
使用 GitHub 警告框 #
markdown
> [!NOTE]
> 这是一个提示。
> [!WARNING]
> 这是一个警告。
总结要点 #
章节末尾总结 #
markdown
## 本节要点
1. 要点一
2. 要点二
3. 要点三
文档末尾总结 #
markdown
## 总结
本文介绍了:
- 内容一
- 内容二
- 内容三
下一步建议...
可读性检查清单 #
- [ ] 标题层级是否清晰
- [ ] 段落是否简短
- [ ] 是否有目录
- [ ] 代码是否有注释
- [ ] 图片是否有说明
- [ ] 重要内容是否突出
- [ ] 是否有总结
下一步 #
继续学习 常见错误!
最后更新:2026-03-24