# 文章模板

本文档定义了文档站的标准文章格式。生成文档时必须遵循此模板。

## 文件命名规范

- 使用 kebab-case：`cache-breakdown.md`、`bloom-filter.md`
- 英文命名，内容用中文
- 放入对应主题目录（algorithm/、architecture/、project/ 等）

## 文章结构模板

```markdown
# 文章标题

!!! note "一句话摘要，概括本文核心内容"

---

## 核心概念

1. **概念一** — 简要说明
2. **概念二** — 简要说明
3. **概念三** — 简要说明

## 详解

### 原理/机制

用文字和图表解释核心原理。推荐使用 mermaid 图表：

```mermaid
graph TD
    A[开始] --> B[处理]
    B --> C[结束]
```

### 关键参数/配置

| 参数 | 说明 | 默认值 |
|------|------|--------|
| param1 | 描述 | value1 |
| param2 | 描述 | value2 |

### 对比分析（如有）

| 特性 | 方案 A | 方案 B |
|------|--------|--------|
| 特点1 | ... | ... |

## 代码示例

```go
// 以 Go 语言为主，注释用中文
func example() {
    // 实现细节
}
```

## 常见陷阱

!!! warning "陷阱一"
    描述常见错误及其规避方法。

!!! warning "陷阱二"
    描述另一个需要注意的问题。

## 练习题

??? question "题目一：xxx？"
    ??? success "答案"
        解答内容。

??? question "题目二：xxx？"
    ??? success "答案"
        解答内容。

## 相关链接

- [链接名称](URL) — 简要说明
- [链接名称](URL) — 简要说明
```

## 各部分写作要点

### H1 标题
- 简洁明了，使用中文
- 不超过 20 个字

### note admonition（摘要）
- 一句话概括全文核心
- 让读者 3 秒内判断是否需要阅读

### 核心概念
- 3-5 个关键概念
- 每个概念一句话说明
- 有序列表

### 详解
- 分小节深入讲解
- 优先使用 mermaid 图表辅助说明（流程图、序列图、状态图）
- 用表格做对比和参数说明
- 代码块用于展示关键逻辑
- 详解部分是文章主体，应占全文 60% 以上

### 代码示例
- 完整可运行的 Go 代码
- 中文注释，解释关键逻辑
- 遵循 Go 命名规范（camelCase 变量，PascalCase 导出）

### 常见陷阱
- 使用 `!!! warning` admonition
- 每个陷阱说明：错误现象、原因、解决方案
- 2-4 个

### 练习题
- 使用 `??? question` 可折叠
- 答案用嵌套的 `??? success "答案"`
- 2-3 道题，覆盖文章核心知识点

### 相关链接
- 外部参考链接
- 每个链接附简要说明