abot/产品需求说明书.md

# ABOT 用户操作手册

## 文档信息

| 文档名称 | ABOT 用户操作手册 |
| :------ | :---------------------- |
| 版本号   | V1.0                   |
| 状态     | 正式版                  |
| 创建日期 | 2024年5月              |

## 目录

1. [系统简介](#1-系统简介)
2. [安装与配置](#2-安装与配置)
3. [基本功能](#3-基本功能)
4. [AI对话功能](#4-ai对话功能)
5. [群聊管理功能](#5-群聊管理功能)
6. [群聊总结功能](#6-群聊总结功能)
7. [游戏任务系统](#7-游戏任务系统)
8. [积分交易系统](#8-积分交易系统)
9. [签到系统](#9-签到系统)
10. [常见问题解答](#10-常见问题解答)

## 1. 系统简介

ABOT 是一款功能丰富的微信机器人系统，旨在提升您的微信使用体验。本系统基于 Python 开发，通过与微信客户端交互，实现消息的自动化处理、智能回复、群聊管理等多种功能。

### 1.1 主要功能

- **AI智能对话**：支持多种AI模型，提供智能对话能力
- **群聊管理**：自动欢迎新成员，监控群成员变动
- **群聊总结**：自动总结群聊内容，识别热门话题
- **游戏任务系统**：提供百科问答游戏，增加群聊趣味性
- **积分系统**：支持用户积分管理和交易
- **签到系统**：提供每日签到功能，支持连续签到奖励

### 1.2 适用场景

- 个人用户：提升微信使用体验，自动化处理日常消息
- 群组管理员：辅助管理微信群，提高群聊活跃度
- 企业用户：用于客户服务、内部沟通自动化等场景

## 2. 安装与配置

### 2.1 系统要求

- **操作系统**：Windows 10/11（推荐）
- **微信客户端**：PC版微信客户端
- **Python环境**：Python 3.8或更高版本

### 2.2 安装步骤

1. **下载安装包**
   - 从官方网站或GitHub仓库下载最新版本的ABOT安装包

2. **解压文件**
   - 将下载的压缩包解压到您选择的目录，例如：`D:\ABOT`

3. **安装依赖**
   - 打开命令提示符（CMD）
   - 进入ABOT目录：`cd D:\ABOT`
   - 安装依赖包：`pip install -r requirements.txt`

4. **配置文件设置**
   - 复制`config.example.yaml`为`config.yaml`
   - 使用文本编辑器打开`config.yaml`
   - 按照注释说明配置数据库连接、微信管理员与 AI 模型参数
   - 敏感信息优先通过环境变量注入，例如 `ABOT_DB_PASSWORD`、`ABOT_LLM_DIFY_WORKFLOW_CHAT_API_KEY`

### 2.3 启动系统

1. **启动微信客户端**
   - 确保您已登录PC版微信客户端

2. **启动ABOT**
   - 双击`bot_start.bat`文件
   - 或在命令提示符中运行：`python main.py`

3. **验证启动**
   - 系统启动后，会在控制台显示启动信息
   - 可以在微信中发送`#帮助`命令测试系统是否正常运行

## 3. 基本功能

### 3.1 通用命令

| 命令 | 功能描述 |
| ---- | ------- |
| `#帮助` | 显示帮助信息 |
| `#菜单` | 显示功能菜单 |
| `#状态` | 查看机器人状态 |
| `#版本` | 查看系统版本信息 |

### 3.2 功能开关命令

| 命令 | 功能描述 |
| ---- | ------- |
| `#菜单状态` | 查看各功能启用状态 |
| `[功能]-启用` | 启用特定功能（需管理员权限） |
| `[功能]-关闭` | 关闭特定功能（需管理员权限） |

### 3.3 使用示例

```
用户：#帮助
机器人：ABOT帮助信息
可用命令：
#帮助 - 显示此帮助信息
#菜单 - 显示功能菜单
#状态 - 查看机器人状态
...（更多命令）

用户：#菜单
机器人：ABOT功能菜单
1. AI对话 - @机器人 进行对话
2. 群聊总结 - #总结 生成群聊摘要
3. 百科问答 - #出题 开始游戏
...（更多功能）
```

## 4. AI对话功能

### 4.1 基本使用

AI对话功能支持与多种AI模型进行智能对话，系统会记住对话上下文，提供连贯的交流体验。

#### 4.1.1 触发方式

- 在群聊中：`@机器人 [问题内容]`
- 在私聊中：直接发送问题

#### 4.1.2 模型切换

| 命令 | 功能描述 |
| ---- | ------- |
| `#切换模型 [模型名称]` | 切换AI对话使用的模型 |
| `#模型列表` | 查看可用的AI模型列表 |

### 4.2 使用示例

```
用户：@机器人 请介绍一下Python语言的特点
机器人：Python是一种高级编程语言，具有以下特点：
1. 简洁易读的语法
2. 强大的第三方库支持
3. 跨平台兼容性
4. 解释型语言，无需编译
5. 支持多种编程范式，包括面向对象、命令式和函数式编程
...

用户：#切换模型 豆包
机器人：已切换到豆包模型，您可以继续对话。
```

## 5. 群聊管理功能

### 5.1 自动欢迎

当新成员加入群聊时，系统会自动发送欢迎消息。

#### 5.1.1 配置欢迎消息

| 命令 | 功能描述 |
| ---- | ------- |
| `#设置欢迎语 [欢迎内容]` | 设置群欢迎语（需管理员权限） |
| `#查看欢迎语` | 查看当前群欢迎语 |

### 5.2 群成员管理

| 命令 | 功能描述 |
| ---- | ------- |
| `#群成员` | 查看群成员列表 |
| `#群统计` | 查看群活跃度统计 |

### 5.3 使用示例

```
[新成员张三加入群聊]
机器人：欢迎张三加入本群！请简单介绍一下自己吧~

用户：#设置欢迎语 欢迎加入我们的大家庭，请阅读群公告了解群规则。
机器人：欢迎语设置成功！

用户：#群成员
机器人：当前群成员（共25人）：
张三、李四、王五...
```

## 6. 群聊总结功能

### 6.1 基本使用

群聊总结功能可以自动分析群聊内容，生成精华摘要，帮助用户快速了解群聊动态。

#### 6.1.1 触发方式

| 命令 | 功能描述 |
| ---- | ------- |
| `#总结` 或 `#summary` | 生成群聊总结 |

### 6.2 使用说明

- 总结功能需要群内有足够的历史消息（至少100条）
- 总结结果会以图片形式发送到群聊
- 总结内容包括热门话题、活跃成员、关键信息等

### 6.3 使用示例

```
用户：#总结
机器人：[发送一张包含以下内容的图片]

【群聊总结】2024-05-20
今日热门话题：
1. Python编程技巧讨论（15条消息）
2. 周末聚会安排（12条消息）
3. 新项目进展汇报（8条消息）

活跃成员：
🥇 张三：25条消息
🥈 李四：18条消息
🥉 王五：12条消息

重要信息：
1. 本周六下午3点在咖啡厅举行技术分享会
2. 项目截止日期延期至下周五
3. 新版本将于周四发布

【tokens】输入: 3245 生成: 512 总: 3757
```

## 7. 游戏任务系统

### 7.1 百科问答游戏

百科问答游戏是一个基于积分的知识问答系统，用户可以通过回答问题获取积分。

#### 7.1.1 基本命令

| 命令 | 功能描述 |
| ---- | ------- |
| `#出题` | 获取一个随机问题 |
| `#答案 [答案内容]` | 提交答案 |
| `#提示` | 获取当前问题的提示 |
| `#放弃` | 放弃当前问题 |

#### 7.1.2 查询命令

| 命令 | 功能描述 |
| ---- | ------- |
| `#积分` | 查看个人积分 |
| `#排行` | 查看积分排行榜 |
| `#任务` | 查看当前活跃的任务 |

### 7.2 使用示例

```
用户：#出题
机器人：【百科问答】
问题：被称为"计算机科学之父"的数学家是谁？
难度：★★☆☆☆
积分：10分
请使用 #答案 [您的答案] 回答

用户：#答案 阿兰·图灵
机器人：恭喜您答对了！
正确答案：阿兰·图灵
您获得了10积分，当前积分：85

用户：#排行
机器人：【积分排行榜】
🥇 张三：120分
🥈 李四：85分
🥉 王五：65分
...
```

## 8. 积分交易系统

### 8.1 基本使用

积分交易系统允许用户之间转移积分，支持多种命令格式。

#### 8.1.1 转账命令

以下命令均可用于积分转账：
- `积分转账 [积分数] @[用户]`
- `积分交易 [积分数] @[用户]`
- `积分赠送 [积分数] @[用户]`
- `转账积分 [积分数] @[用户]`
- `送积分 [积分数] @[用户]`

#### 8.1.2 查询命令

| 命令 | 功能描述 |
| ---- | ------- |
| `#积分` | 查看个人积分余额 |
| `#积分记录` | 查看积分交易历史 |

### 8.2 使用示例

```
用户：积分转账 20 @李四
机器人：转账成功！
您已向李四转账20积分
您的当前积分：65
李四的当前积分：105

用户：#积分
机器人：您的当前积分：65
积分来源：
- 答题获得：+85
- 转账支出：-20
```

## 9. 签到系统

### 9.1 基本使用

签到系统允许用户每日签到获取积分，支持连续签到奖励。

#### 9.1.1 签到命令

| 命令 | 功能描述 |
| ---- | ------- |
| `#签到` | 执行每日签到 |
| `#我的签到` | 查看签到记录 |
| `#签到排行` | 查看签到排行榜 |

### 9.2 签到规则

- 每人每天只能签到一次
- 连续签到有额外奖励：
  - 连续3天：基础积分×1.2
  - 连续7天：基础积分×1.5
  - 连续30天：基础积分×2.0
- 节假日签到有额外奖励

### 9.3 使用示例

```
用户：#签到
机器人：签到成功！
今日获得5积分
您已连续签到3天，获得额外奖励1积分
当前总积分：71

用户：#我的签到
机器人：【签到记录】
连续签到：3天
本月签到：15天
总计签到：45天
下次额外奖励：连续签到7天
```

## 10. 常见问题解答

### 10.1 系统问题

**Q: 系统启动失败，显示"无法连接到微信客户端"怎么办？**

A: 请检查以下几点：
- 确保PC版微信客户端已启动并登录
- 确保wcferry服务正常运行
- 尝试重启微信客户端和ABOT

**Q: 命令发送后没有响应怎么办？**

A: 可能的原因：
- 命令格式错误，请检查命令格式
- 该功能在当前群组已被禁用
- 系统正在处理其他请求，请稍后再试
- 网络连接不稳定，影响消息传输

**Q: 如何解决AI回复速度慢的问题？**

A: 可以尝试以下方法：
- 切换到响应更快的AI模型（如`#切换模型 豆包`）
- 减少提问内容的复杂度
- 检查网络连接质量
- 在系统配置中调整超时设置

### 10.2 功能问题

**Q: 为什么群聊总结功能无法使用？**

A: 群聊总结功能需要满足以下条件：
- 群聊中至少有100条历史消息
- 该功能在群组中已启用
- AI服务正常运行
- 您有使用该功能的权限

**Q: 积分转账失败的原因有哪些？**

A: 积分转账可能失败的原因：
- 您的积分余额不足
- 转账格式不正确
- 接收方不在系统中
- 转账金额超出限制

**Q: 如何恢复被删除的数据？**

A: 系统会定期备份数据，如需恢复数据，请联系系统管理员。普通用户无法直接恢复已删除的数据。

## 11. 高级功能使用

### 11.1 自定义AI提示词

高级用户可以通过特定命令自定义AI模型的系统提示词，使AI回复更符合特定场景需求。

**使用方法**：
```
#设置提示词 [提示词内容]
```

**示例**：
```
#设置提示词 你是一位幽默风趣的助手，喜欢用emoji表情，回答简洁明了。
```

### 11.2 定时任务设置

您可以设置定时执行的任务，如定时提醒、定时发送消息等。

**使用方法**：
```
#定时 [时间] [内容]
```

**示例**：
```
#定时 每天9:00 请大家记得打卡
```

### 11.3 数据导出

系统支持导出个人数据，包括积分记录、签到历史等。

**使用方法**：
```
#导出数据 [数据类型]
```

**支持的数据类型**：
- 积分记录
- 签到历史
- 游戏记录

## 12. 管理员功能

### 12.1 群组管理

群组管理员可以使用以下命令管理群聊功能：

| 命令 | 功能描述 |
| ---- | ------- |
| `#功能列表` | 查看所有可用功能 |
| `#启用 [功能名]` | 启用特定功能 |
| `#禁用 [功能名]` | 禁用特定功能 |
| `#设置权限 @用户 [权限级别]` | 设置用户权限 |

### 12.2 积分管理

管理员可以管理用户积分：

| 命令 | 功能描述 |
| ---- | ------- |
| `#奖励积分 @用户 [数量] [原因]` | 奖励用户积分 |
| `#扣除积分 @用户 [数量] [原因]` | 扣除用户积分 |
| `#积分重置 @用户` | 重置用户积分（谨慎使用） |

### 12.3 系统监控

管理员可以监控系统状态：

| 命令 | 功能描述 |
| ---- | ------- |
| `#系统状态` | 查看系统运行状态 |
| `#资源使用` | 查看资源使用情况 |
| `#错误日志` | 查看最近的错误日志 |

## 13. 使用技巧

### 13.1 AI对话技巧

1. **提问清晰明确**：明确表达您的需求，避免模糊不清的问题
2. **分步骤提问**：复杂问题可以分成多个简单问题依次提问
3. **利用上下文**：AI会记住对话上下文，可以基于之前的回答继续提问
4. **指定回答格式**：可以要求AI以特定格式回答，如"请用表格列出"

### 13.2 群聊管理技巧

1. **定期总结**：使用`#总结`命令定期总结群聊内容，帮助新成员快速了解讨论主题
2. **合理设置权限**：根据群聊性质设置适当的功能权限
3. **活跃气氛**：定期使用游戏功能增加群聊活跃度
4. **及时清理**：定期清理无用消息，保持群聊环境整洁

### 13.3 积分获取技巧

1. **每日签到**：坚持每日签到，连续签到有额外奖励
2. **积极参与游戏**：参与百科问答游戏获取积分
3. **节假日签到**：节假日签到通常有额外奖励
4. **帮助他人**：回答他人问题可能获得管理员奖励的积分

## 14. 隐私与安全

### 14.1 数据隐私

ABOT 重视用户隐私保护，我们的隐私政策包括：

1. **数据收集**：仅收集必要的用户数据，如微信ID、昵称等
2. **数据使用**：收集的数据仅用于提供服务，不会用于其他商业目的
3. **数据存储**：用户数据存储在安全的数据库中，采取加密措施保护
4. **数据访问**：仅授权人员可以访问用户数据，严格控制访问权限

### 14.2 安全建议

为保障您的账号安全，建议：

1. **不要分享敏感信息**：避免在群聊中分享敏感个人信息
2. **定期检查权限**：定期检查群聊功能权限设置
3. **谨慎使用第三方功能**：使用第三方功能时注意保护个人信息
4. **及时报告问题**：发现安全问题及时向管理员报告

## 15. 联系与支持

如果您在使用过程中遇到任何问题，或有任何建议和反馈，请通过以下方式联系我们：

- **问题反馈**：在群聊中发送`#反馈 [内容]`
- **邮件支持**：support@ABOT.example.com
- **用户社区**：加入我们的用户交流群（请发送`#加群`获取邀请）

我们的技术支持团队将在工作时间内（周一至周五 9:00-18:00）回复您的问题。

## 16. 版本更新

### 16.1 更新方式

当有新版本发布时，您可以通过以下方式更新：

1. **自动更新**：系统会在启动时检查更新，发现新版本会提示更新
2. **手动更新**：
   - 从官方网站下载最新版本
   - 备份您的配置文件（config.yaml）
   - 解压新版本文件，替换旧文件
   - 恢复您的配置文件
   - 重启系统

### 16.2 更新内容

每次更新的具体内容会在发布说明中详细列出，通常包括：
- 新增功能
- 功能改进
- 问题修复
- 性能优化

---

感谢您选择使用ABOT！我们致力于为您提供更好的微信自动化体验。如有任何问题或建议，欢迎随时联系我们。