Files
IC-Coder-Plugin/docs/文档集功能需求文档.md
Roe-xin cab8960159 docs: 添加文档集功能需求文档
详细描述了文档集功能的核心流程、前后端需求和交互逻辑
2026-03-17 17:28:37 +08:00

88 lines
2.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 文档集功能需求文档
## 1. 功能概述
文档集功能允许用户管理文档,在添加上下文时可以选择文档加载到输入框中,发送给 AI 作为对话上下文。
## 2. 核心流程
### 2.1 添加文档集入口
1. 用户点击"添加上下文"中的"文档"按钮
2. 如果文档集为空,显示"添加文档集"按钮
3. 点击按钮跳转到"设置 → 上下文"页面
### 2.2 创建文档集
1. 在设置的上下文页面,点击"添加文档集"按钮
2. 弹出文档集创建对话框
3. 用户输入文档集名称
4. 用户点击"添加文件"按钮,选择文件
5. 系统验证文件(格式、大小、数量)
6. 显示已选文件列表和统计信息
7. 用户点击"确定",保存文档集
8. 系统持久化文档集信息到 `globalState`
### 2.3 使用文档
1. 用户点击"添加上下文"中的"文档"按钮
2. 显示所有文档列表(自动同步设置中的文档集)
3. 用户点击选择一个或多个文档
4. 文档路径加载到输入框中
5. 用户发送消息,后端读取文档内容作为上下文
### 2.4 管理文档集
1. 在设置的上下文页面查看文档列表
2. 显示每个文档的更新时间
3. 支持修改文档名称
4. 支持删除文档
## 3. 功能详细需求
### 3.1 前端需求
#### 3.1.1 添加上下文 - 文档按钮
**功能**:
- 点击"文档"按钮,显示文档列表弹窗
- 如果没有文档,显示"添加文档集"按钮
- 点击"添加文档集"按钮,跳转到设置的上下文页面
#### 3.1.2 文档列表弹窗
**UI 元素**:
- 文档列表(显示所有文档集中的文档)
- 每个文档显示:名称
- 支持多选
- 确定/取消按钮
**交互逻辑**:
- 自动同步设置中的文档集
- 点击文档选中/取消选中
- 点击确定,将选中文档路径加载到输入框
#### 3.1.3 设置 - 上下文页面
**UI 元素**:
- "添加文档集"按钮
- 文档列表
- 每个文档显示:名称、更新时间、修改名称按钮、删除按钮
**交互逻辑**:
- 点击"添加文档集"打开创建对话框
- 点击修改名称,弹出输入框修改
- 点击删除,删除二次确认弹窗 确认删除文档
#### 3.1.4 文档集创建对话框
**UI 元素**:
- 文档集名称输入框
- 添加文件按钮
- 文件列表显示区域
- 确定/取消按钮
**交互逻辑**:
- 点击"添加文件"触发文件选择器
- 显示已选文件的相对路径和大小
- 支持删除单个文件
- 实时更新统计信息
### 3.2 后端需求
后端只需要支持读取pdf,txt,.v,.sv.md这些类型的文档