📝 docs: Add documentation

2025-12-11 03:29:07 +00:00
parent 50e695a1bb
commit 99e7f6062d
135 changed files with 79115 additions and 8 deletions
@@ -0,0 +1,131 @@
+<div v-pre>
+
+# 公告管理
+
+创建和管理系统公告,支持显示控制、置顶和弹窗功能。
+
+## 表格列说明
+
+### 显示 (Show)
+开关按钮,控制公告是否在前台显示。
+
+### 置顶 (Pinned)
+开关按钮,控制公告是否置顶显示。
+
+### 弹窗 (Popup)
+开关按钮,控制用户访问时是否弹窗显示公告。
+
+### 标题 (Title)
+公告标题。
+
+### 内容 (Content)
+公告正文内容(支持Markdown)。
+
+### 更新时间 (Updated At)
+最后更新时间。
+
+## 表格操作
+
+### 编辑
+打开侧边抽屉表单修改公告信息。
+
+### 删除
+删除公告(需确认),不可恢复。
+
+### 批量删除
+选中多个公告后批量删除。
+
+## 公告表单
+
+### 标题 (必填)
+公告的标题文字。
+
+### 内容 (必填)
+公告正文内容,支持Markdown格式:
+- 标题: # ## ###
+- 粗体: **文字**
+- 斜体: *文字*
+- 列表: - 项目
+- 链接: [文字](url)
+- 代码: `代码`
+
+## 筛选功能
+
+### 启用筛选
+- 显示: 查看已显示的公告
+- 隐藏: 查看已隐藏的公告
+
+### 关键词搜索
+输入标题或内容搜索公告。
+
+## 使用场景
+
+### 场景一: 创建重要通知
+
+**表单配置**:
+- 标题: 系统维护通知
+- 内容:
+  ```
+  # 系统维护通知
+
+  本系统将于 **2024年1月1日 02:00-04:00** 进行维护升级。
+
+  ## 影响范围
+  - 网站暂时无法访问
+  - 服务不受影响
+
+  感谢您的理解与支持!
+  ```
+- 显示: 开启
+- 置顶: 开启
+- 弹窗: 开启
+
+### 场景二: 创建活动公告
+
+**表单配置**:
+- 标题: 双11优惠活动
+- 内容:
+  ```
+  ## 🎉 双11优惠活动
+
+  - 全场套餐 **8折** 优惠
+  - 年付套餐额外赠送 **30天**
+  - 活动时间: 11.11-11.13
+
+  [立即购买](/subscribe)
+  ```
+- 显示: 开启
+- 置顶: 开启
+- 弹窗: 否
+
+### 场景三: 创建使用说明
+
+**表单配置**:
+- 标题: 新手使用指南
+- 内容:
+  ```
+  # 新手使用指南
+
+  ## 1. 购买套餐
+  进入 [订阅页面](/subscribe) 选择合适的套餐
+
+  ## 2. 下载客户端
+  前往 [文档中心](/docs) 下载对应平台客户端
+
+  ## 3. 导入配置
+  复制订阅链接到客户端即可使用
+  ```
+- 显示: 开启
+- 置顶: 否
+- 弹窗: 否
+
+## 重要提示
+
+1. **Markdown支持**: 内容支持Markdown格式,可排版精美公告
+2. **弹窗功能**: 开启后用户每次访问都会弹窗提示
+3. **置顶显示**: 置顶公告会在列表最上方
+4. **显示控制**: 可先创建后再开启显示
+5. **批量删除**: 删除操作不可恢复,谨慎操作
+6. **更新时间**: 每次编辑都会更新时间戳
+
+</div>
@@ -0,0 +1,155 @@
+<div v-pre>
+
+# 营销管理
+
+提供邮件营销和配额服务两大营销功能,用于批量触达用户和赠送福利。
+
+## 功能模块
+
+### 邮件营销 (Email Marketing)
+
+包含两个功能:
+
+#### 1. 邮件群发
+
+批量发送营销邮件给用户。
+
+**表单字段**:
+
+- **邮件主题** (必填) - 邮件标题
+- **邮件内容** (必填) - 支持HTML编辑器,可设计富文本邮件
+- **发送范围** - 选择目标用户群体:
+  - 全部用户
+  - 有订阅用户
+  - 无订阅用户
+  - 按注册时间筛选
+- **注册时间范围** (可选) - 筛选特定时间段注册的用户
+- **附加邮箱** (可选) - 手动输入额外邮箱地址,每行一个
+- **定时发送** (可选) - 设置未来发送时间
+- **发送间隔** (可选) - 每封邮件间隔秒数(最小0.1秒)
+- **每日限额** (可选) - 每天最多发送数量(最小1)
+
+**收件人统计**:
+表单实时显示:
+- 系统用户数
+- 附加邮箱数
+- 总计收件人数
+
+#### 2. 邮件任务管理
+
+查看和管理邮件发送任务。
+
+**任务列表显示**:
+- 任务ID
+- 主题
+- 发送状态
+- 已发送数量
+- 总数量
+- 创建时间
+
+**任务操作**:
+- 查看详情
+- 暂停/恢复
+- 删除任务
+
+### 配额服务 (Quota Service)
+
+批量赠送用户流量、天数或余额。
+
+#### 1. 配额群发
+
+批量赠送福利给订阅用户。
+
+**表单字段**:
+
+- **选择套餐** (必填) - 多选目标产品套餐
+- **订阅状态** - 筛选条件:
+  - 仅活跃订阅
+  - 包含过期订阅
+- **订阅时间范围** (可选) - 筛选特定时间段订阅的用户
+- **是否重置流量** - 开关,赠送时是否重置用户流量
+- **赠送类型** (必填) - 单选:
+  - 流量 (GB)
+  - 天数
+  - 余额
+- **赠送数值** (必填) - 具体赠送数量
+
+**收件人统计**:
+表单实时显示符合条件的用户数。
+
+#### 2. 配额任务管理
+
+查看和管理配额发放任务。
+
+**任务列表显示**:
+- 任务ID
+- 套餐名称
+- 赠送类型和数量
+- 处理状态
+- 已处理/总数
+- 创建时间
+
+**任务操作**:
+- 查看详情
+- 删除任务
+
+## 使用场景
+
+### 场景一: 新用户欢迎邮件
+
+**邮件群发配置**:
+- 邮件主题: 欢迎加入!
+- 邮件内容: 设计欢迎邮件(HTML)
+- 发送范围: 全部用户
+- 注册时间: 最近7天
+- 发送间隔: 1秒
+- 每日限额: 1000
+
+### 场景二: 促销活动通知
+
+**邮件群发配置**:
+- 邮件主题: 限时优惠!年付套餐8折
+- 邮件内容: 活动详情(HTML)
+- 发送范围: 有订阅用户
+- 定时发送: 活动开始前1小时
+
+### 场景三: 赠送流量福利
+
+**配额群发配置**:
+- 选择套餐: 标准月付
+- 订阅状态: 仅活跃订阅
+- 订阅时间: 过去30天
+- 重置流量: 否
+- 赠送类型: 流量
+- 赠送数值: 10 GB
+
+### 场景四: 赠送会员时长
+
+**配额群发配置**:
+- 选择套餐: 所有套餐
+- 订阅状态: 仅活跃订阅
+- 重置流量: 否
+- 赠送类型: 天数
+- 赠送数值: 7
+
+### 场景五: 充值余额返现
+
+**配额群发配置**:
+- 选择套餐: 高级套餐
+- 订阅状态: 仅活跃订阅
+- 订阅时间: 过去7天
+- 赠送类型: 余额
+- 赠送数值: 10元
+
+## 重要提示
+
+1. **邮件发送**: 注意发送间隔和限额,避免被判定为垃圾邮件
+2. **HTML内容**: 邮件支持富文本,可设计精美营销内容
+3. **定时任务**: 可设置未来时间自动发送
+4. **实时统计**: 收件人数实时计算,提交前可预览
+5. **任务管理**: 可查看任务执行进度和状态
+6. **配额赠送**: 配额立即发放,不可撤回
+7. **流量重置**: 勾选后会重置用户当前流量
+8. **套餐筛选**: 可精准选择目标用户群体
+
+</div>