# 项目文档结构模板

本模板定义了项目文档的标准结构，请严格按照以下格式生成 {PROJECT} 的完整文档。

## 文档结构

项目文档应包含以下 **4个必需章节**，缺一不可：

### 1. 项目概述（必需）
**内容要求**：
- 项目的背景和目的
- 项目的核心价值和定位
- 目标用户和适用场景
- 项目当前状态（版本、开发阶段）

**字数要求**：150-300字

**示例结构**：
```
## 项目概述

{PROJECT} 是一个...（介绍项目背景和目的）

本项目旨在...（说明核心价值）

主要面向...（目标用户）用户，适用于...（应用场景）场景。

当前版本：vX.X.X，处于...（开发阶段）阶段。
```

### 2. 功能说明（必需）
**内容要求**：
- 详细介绍每个核心功能
- 说明功能的使用方法和注意事项
- 如有扩展功能，单独说明

**字数要求**：300-800字

**组织形式**：
```
## 功能说明

### 核心功能

#### 1. 功能A
（详细说明功能A的作用、使用方法、参数说明等）

#### 2. 功能B
（详细说明功能B...）

### 扩展功能

#### 1. 高级功能C
（说明扩展功能...）
```

### 3. 技术架构（必需）
**内容要求**：
- 技术栈（编程语言、框架、依赖库）
- 架构设计（模块划分、组件关系）
- 核心算法或实现原理（如有）
- 性能特性和优化方法

**字数要求**：200-500字

**示例结构**：
```
## 技术架构

### 技术栈
- **编程语言**：Python 3.8+
- **核心框架**：...
- **依赖库**：...

### 架构设计
（描述整体架构、模块划分）

### 核心实现
（说明关键算法或技术要点）

### 性能特性
（说明性能优化措施）
```

### 4. 使用方法（必需）
**内容要求**：
- 安装步骤（如适用）
- 基本使用示例
- 常见使用场景的代码示例
- 注意事项和常见问题

**字数要求**：200-500字

**示例结构**：
```
## 使用方法

### 安装
（安装步骤）

### 基本使用
（简单的使用示例）

### 使用示例
（具体场景的代码示例）

### 注意事项
（使用中需要注意的问题）
```

## 格式规范

### Markdown 格式要求
1. **标题层级**：一级标题用 `#`，二级标题用 `##`，以此类推
2. **列表格式**：无序列表用 `-`，有序列表用 `1.` `2.` 等
3. **代码块**：使用三个反引号包裹代码，指定语言类型
4. **粗体强调**：重要概念用 `**粗体**` 标注
5. **链接格式**：`[链接文本](URL)`

### 语言要求
- 使用 **{DOC_GEN_LANG}** 编写全部内容
- 专业术语使用准确
- 句子通顺，逻辑清晰
- 避免口语化表达

### 质量要求
- **完整性**：4个必需章节都必须包含
- **充实度**：每个章节都应有实质性内容，不能只有标题
- **准确性**：所有信息基于项目实际情况，不臆造
- **规范性**：严格遵循 Markdown 格式规范

## 文档模板示例

以下是一个完整的文档框架示例：

```markdown
# {PROJECT} 项目文档

## 项目概述
（150-300字，介绍项目背景、目的、用户、状态）

## 功能说明

### 核心功能

#### 1. 功能名称A
（详细说明）

#### 2. 功能名称B
（详细说明）

### 扩展功能

#### 1. 高级功能C
（详细说明）

## 技术架构

### 技术栈
- **编程语言**：...
- **核心框架**：...

### 架构设计
（架构描述）

### 核心实现
（实现要点）

## 使用方法

### 安装
（安装步骤）

### 基本使用
（使用示例）

### 注意事项
（注意事项）
```

## 检查清单

在完成文档编写后，请确认：

- [ ] 包含全部4个必需章节
- [ ] 每个章节都有实质性内容（不是空章节）
- [ ] 使用 {DOC_GEN_LANG} 编写
- [ ] 遵循 Markdown 格式规范
- [ ] 总字数在 800-3000 字之间
- [ ] 信息准确，基于实际项目内容
- [ ] 结构清晰，逻辑连贯
