---
name: project-context-template
description: 项目上下文文档模板，通过 #project-context-template 引用
---

# 项目上下文文档模板

> 新项目启动时使用此模板生成上下文文档

---

## 使用方法

在开始新项目时，复制以下模板并填写相关信息，作为项目的 `CONTEXT.md` 文件。

---

## 模板

```markdown
# 项目上下文文档

## 1. 项目概要

### 项目名称
[项目名称]

### 项目背景
[为什么要做这个项目？解决什么问题？]

### 目标与目的
[项目要达成的具体目标]

### 非目标
[明确不做什么，避免范围蔓延]

---

## 2. 范围定义

### 当前范围
- [功能1]
- [功能2]
- [功能3]

### 非本次范围
- [暂不实现的功能1]
- [暂不实现的功能2]

### 约束条件
- [技术约束]
- [时间约束]
- [资源约束]

---

## 3. 关键实体与关系

### 核心实体
| 实体 | 职责 |
|:---|:---|
| [实体1] | [职责描述] |
| [实体2] | [职责描述] |

### 实体关系
[描述实体之间的关系，可用 Mermaid 图]

---

## 4. 功能模块

### 模块列表
| 模块 | 输入 | 输出 | 核心逻辑 |
|:---|:---|:---|:---|
| [模块1] | [输入] | [输出] | [逻辑] |
| [模块2] | [输入] | [输出] | [逻辑] |

### 典型用户场景
1. [场景1描述]
2. [场景2描述]

---

## 5. 技术方向

### 技术栈
- 语言：[Python/TypeScript/...]
- 框架：[FastAPI/React/...]
- 数据库：[PostgreSQL/SQLite/...]
- 其他：[...]

### 数据流
```
[数据源] → [处理模块] → [存储] → [输出]
```

### 已做技术决策
1. [决策1及原因]
2. [决策2及原因]

### 可替代方案
- [方案A]：[优缺点]
- [方案B]：[优缺点]

---

## 6. 依赖库（胶水编程）

### 核心依赖
| 库名 | 用途 | 版本 | 文档链接 |
|:---|:---|:---|:---|
| [库1] | [用途] | [版本] | [链接] |
| [库2] | [用途] | [版本] | [链接] |

### 依赖关系图
```
[你的代码] → [库A] → [库B]
           → [库C]
```

---

## 7. 目录结构

```
project/
├── README.md
├── requirements.txt
├── .env.example
├── src/
│   ├── core/          # 核心业务逻辑
│   ├── glue/          # 胶水代码
│   └── utils/         # 工具函数
├── tests/
└── docs/
```

---

## 8. 当前进展

### 已确认事实
- [x] [已完成事项1]
- [x] [已完成事项2]

### 未解决问题
- [ ] [待解决问题1]
- [ ] [待解决问题2]

---

## 9. 后续计划

### 待讨论主题
1. [主题1]
2. [主题2]

### 潜在风险
- [风险1]：[应对策略]
- [风险2]：[应对策略]

---

## 10. 交互约定

### AI 输出风格
- 结构清晰、层级明确、工程化表达
- 统一使用 Markdown
- 必要时使用伪代码或列表

### 用户特殊偏好
[按需填写]
```

---

## 快速启动提示词

```
请帮我创建一个项目上下文文档。

项目目标：[一句话描述]
技术栈偏好：[Python/TypeScript/...]
时间约束：[...]

请按照项目上下文文档模板的格式输出。
```
