324 lines
8.7 KiB
Markdown
324 lines
8.7 KiB
Markdown
# 福建水务营收系统设计文档
|
||
|
||
## 前言
|
||
|
||
本文档为福建水务营收系统的概要设计文档，基于RuoYi-Vue-Pro后端框架和yudao-ui-admin-vue3前端框架，旨在满足原有系统的所有功能需求，并通过技术升级提升系统的性能、安全性和用户体验。
|
||
|
||
## 目录
|
||
|
||
### 一、设计计划
|
||
|
||
- [设计计划文档](water_biz_design_plan.md)
|
||
- 项目背景与概述
|
||
- 系统设计总体规划
|
||
- 编写工作步骤与时间规划
|
||
- 人员分工建议
|
||
- 文档规范与模板
|
||
- Cursor Rules配置
|
||
- 协作工具与流程
|
||
- 成果交付物
|
||
|
||
- [Cursor Rules配置指南](cursor_rules.md)
|
||
- Cursor Rules概述
|
||
- 基础规则配置
|
||
- 业务领域规则
|
||
- 图表规范
|
||
- 代码示例规范
|
||
- 引用链接规范
|
||
- 表格规范
|
||
- 自定义规则配置方法
|
||
- 规则应用建议
|
||
- 常见问题解决
|
||
|
||
### 二、系统架构设计
|
||
|
||
- [系统架构概要设计](water_biz_system_architecture.md)
|
||
- 系统架构概述
|
||
- 总体架构设计
|
||
- 系统分层设计
|
||
- 核心模块设计
|
||
- 数据库设计
|
||
- 接口设计
|
||
- 安全设计
|
||
- 高可用设计
|
||
- 扩展性设计
|
||
- 部署架构
|
||
|
||
### 三、模块功能设计
|
||
|
||
- [核心模块功能设计](water_biz_module_design.md)
|
||
- 系统功能模块概览
|
||
- 用户管理模块
|
||
- 水表管理模块
|
||
- 抄表管理模块
|
||
- 收费管理模块
|
||
- 账务管理模块
|
||
- 票据管理模块
|
||
- 营业网点管理模块
|
||
- 报表管理模块
|
||
- 系统管理模块
|
||
- 集成接口模块
|
||
|
||
### 四、数据库设计
|
||
|
||
- [数据库设计](water_biz_database_design.md)
|
||
- 数据库设计概述
|
||
- 数据库架构设计
|
||
- 数据模型设计
|
||
- 数据库表结构设计
|
||
- 数据库优化设计
|
||
- 数据库安全设计
|
||
- 数据备份与恢复
|
||
- 数据库监控与维护
|
||
|
||
### 五、接口设计
|
||
|
||
- [接口设计](water_biz_interface_design.md)
|
||
- 接口设计概述
|
||
- 接口设计原则
|
||
- 内部模块接口
|
||
- 外部系统接口
|
||
- 接口安全设计
|
||
- 接口测试策略
|
||
- 接口文档管理
|
||
|
||
### 六、部署运维设计
|
||
|
||
- [部署运维设计](water_biz_deployment_design.md)
|
||
- 部署架构设计
|
||
- 软件部署方案
|
||
- 容器化部署方案
|
||
- 系统运维方案
|
||
- 持续集成与部署
|
||
- 灾备方案
|
||
- 运维工具链
|
||
- 运维管理规范
|
||
|
||
### 七、总结
|
||
|
||
- [概要设计文档总结](water_biz_summary.md)
|
||
- 文档构成
|
||
- 主要内容概述
|
||
- 编写建议
|
||
- 后续工作建议
|
||
- 常见问题与解决方案
|
||
|
||
## 业务专业术语
|
||
|
||
本部分定义了福建水务业务系统中常用的专业术语，以便于相关人员理解和使用系统。
|
||
|
||
### 基础术语
|
||
|
||
#### 站点
|
||
用于划分用户所属管辖区域，站点可以进行多级管理。通常指水务公司下属的营业网点或服务站。
|
||
|
||
#### 册本
|
||
又称抄表本或抄表簿，根据抄表线路规划，按排相邻的一些水表给某一个抄表员进行抄表；册本的属性有册本编号、册本名称、抄表员、抄表工次、抄表周期、起抄日期等。
|
||
|
||
#### 用户编号
|
||
为签定了供用水合同的正式用户分配的唯一识别号，用户编号自立户时自动由系统按指定规则产生，用户编号一旦生成，不能因过户、用水性质发生变更等原因而改变。
|
||
|
||
#### 水表分类
|
||
水表分类分为单表、总分表等。单表是指只服务一个用户的水表；总分表是指一个总表下面有多个分表的情况，通常用于小区或企业用水管理。
|
||
|
||
### 水量与计费术语
|
||
|
||
#### 售水量
|
||
抄收水量+查处水量±调整水量
|
||
|
||
#### 抄收水量
|
||
通过抄表收费的水量
|
||
|
||
#### 调整水量
|
||
优惠水量+减免水量+抄表（录入）误差
|
||
|
||
#### 当期应收水费
|
||
当期售水量乘以不同类别的水价（到户价）所得的金额
|
||
|
||
#### 当期实收水费
|
||
实收当期水费和实收历史欠费
|
||
|
||
#### 当期欠费
|
||
当期内未到账的当期应收水费
|
||
|
||
#### 历史欠费
|
||
当期前未到账的应收水费
|
||
|
||
### 业务指标术语
|
||
|
||
#### 当期水费回收率
|
||
(当期应收水费－当期未收水费)/当期应收水费×100%
|
||
|
||
#### 历史欠费回收率
|
||
实收历史欠费/应收历史欠费×100%
|
||
|
||
#### 水表抄见率
|
||
(当期应抄用户数-当期估表用户数)/当期应抄用户数×100%
|
||
|
||
#### 同比
|
||
(本期-上年同期)/上年同期×100%
|
||
|
||
#### 环比
|
||
(本期-上期)/上期×100%
|
||
|
||
### 抄表与收费术语
|
||
|
||
#### 人工抄表
|
||
抄表员按照册本顺序，通过人工方式上门抄录水表示数的方式。
|
||
|
||
#### 远传抄表
|
||
通过自动抄表系统，远程采集水表数据的方式。
|
||
|
||
#### 自报抄表
|
||
由用户自行报送水表示数的抄表方式。
|
||
|
||
#### 估表
|
||
当无法获取实际水表示数时，系统根据历史用水量估算的当期用水量。
|
||
|
||
#### 复核抄表
|
||
对抄表数据进行复核确认的过程，通常针对异常数据或抽查。
|
||
|
||
#### 开账
|
||
根据抄表数据，生成用户水费账单的过程。
|
||
|
||
#### 销账
|
||
用户缴纳水费后，系统将应收水费标记为已收的过程。
|
||
|
||
### 表务与报装术语
|
||
|
||
#### 表务工单
|
||
针对水表安装、维修、更换等业务的工作单据。
|
||
|
||
#### 换表
|
||
将用户的旧水表更换为新水表的业务流程。
|
||
|
||
#### 移表
|
||
改变水表安装位置的业务流程。
|
||
|
||
#### 校表
|
||
检测并校准水表精度的业务流程。
|
||
|
||
#### 报装
|
||
用户申请新装水表，办理用水手续的业务流程。
|
||
|
||
#### 一户一表
|
||
每户用户单独安装水表计量用水的管理模式。
|
||
|
||
#### 总分表
|
||
一个总表下面有多个分表的水表安装方式，通常用于小区或企业等集中用水场所。
|
||
|
||
### 账务与支付术语
|
||
|
||
#### 预付款
|
||
用户预先缴纳的水费，存入用户账户，用于抵扣后续水费的款项。
|
||
|
||
#### 银行托收
|
||
通过银行批量自动从用户账户中扣除水费的方式。
|
||
|
||
#### 违约金
|
||
用户逾期未缴纳水费，按规定收取的滞纳金。
|
||
|
||
#### 退款
|
||
将用户多缴或预付的水费退还给用户的业务流程。
|
||
|
||
#### 调价
|
||
水价调整的业务流程，包括调价申请、审批、执行等环节。
|
||
|
||
### 系统管理术语
|
||
|
||
#### 多租户
|
||
系统支持多个组织机构独立运营、数据隔离的架构模式。
|
||
|
||
#### 单点登录
|
||
用户只需登录一次，就可以访问系统内所有相互信任的应用系统的功能。
|
||
|
||
#### 角色权限
|
||
基于角色的权限管理模式，通过角色定义不同用户的操作权限。
|
||
|
||
#### 业务参数
|
||
系统中各种可配置的参数，用于适应不同业务场景和需求。
|
||
|
||
#### 水价体系
|
||
水务公司制定的各类用户水价标准体系，可能包含基本水价、阶梯水价等多种形式。
|
||
|
||
### 客户服务术语
|
||
|
||
#### 微网厅
|
||
通过微信公众号提供的自助服务平台，用户可查询账单、缴费、查看用水情况等。
|
||
|
||
#### 服务窗
|
||
支付宝平台上提供的自助服务渠道。
|
||
|
||
#### 电子发票
|
||
系统自动生成并发送给用户的电子形式发票。
|
||
|
||
#### 催缴
|
||
对欠费用户进行催缴的业务流程，可通过短信、电话、上门等多种方式。
|
||
|
||
## 附录
|
||
|
||
### 附录A：参考文档
|
||
|
||
- 原系统《营收系统_详细设计说明书》
|
||
- 原系统《营收系统_需求规格说明书》
|
||
- 原系统《营收系统_用户操作手册》
|
||
- RuoYi-Vue-Pro框架开发文档
|
||
- yudao-ui-admin-vue3框架开发文档
|
||
|
||
### 附录B：术语表
|
||
|
||
| 术语 | 定义 |
|
||
|-----|-----|
|
||
| 抄表 | 指读取水表示数的过程 |
|
||
| 水价 | 指每立方米水的价格 |
|
||
| 阶梯水价 | 按用水量分段计价的水价政策 |
|
||
| 远传水表 | 能够自动传输读数的智能水表 |
|
||
| 账务 | 指水费收取后的账务处理过程 |
|
||
| RBAC | 基于角色的访问控制(Role-Based Access Control) |
|
||
| JWT | JSON Web Token，用于身份认证的开放标准 |
|
||
| Redis | 内存数据结构存储，用作数据库、缓存和消息中间件 |
|
||
|
||
### 附录C：项目成员
|
||
|
||
| 角色 | 姓名 | 职责 |
|
||
|-----|-----|-----|
|
||
| 项目经理 | [姓名] | 整体项目规划与管理 |
|
||
| 架构师 | [姓名] | 系统架构设计 |
|
||
| 前端负责人 | [姓名] | 前端技术选型与设计 |
|
||
| 后端负责人 | [姓名] | 后端技术选型与设计 |
|
||
| 数据库设计师 | [姓名] | 数据库设计与优化 |
|
||
| 测试负责人 | [姓名] | 测试策略与测试用例设计 |
|
||
| 运维负责人 | [姓名] | 部署方案与运维设计 |
|
||
|
||
# 福建水务业务系统技术文档目录
|
||
|
||
## 1. 系统概述
|
||
1.1 系统背景
|
||
1.2 系统目标
|
||
1.3 系统范围
|
||
1.4 系统用户
|
||
1.5 系统特点
|
||
1.6 系统价值
|
||
|
||
## 2. 系统架构
|
||
2.1 架构概述
|
||
2.2 技术架构
|
||
2.3 应用架构
|
||
2.4 数据架构
|
||
2.5 部署架构
|
||
2.6 安全架构
|
||
|
||
## 3. 技术框架
|
||
3.1 框架概述
|
||
3.2 RuoYi-Vue-Pro框架
|
||
3.2.1 框架介绍
|
||
3.2.2 核心功能
|
||
3.2.3 技术特点
|
||
3.2.4 框架模块结构
|
||
3.2.5 扩展机制
|
||
3.3 yudao-ui-admin-vue3框架
|
||
3.3.1 框架介绍
|
||
3.3.2 组件体系
|
||
3.3.3 技术特点
|
||
3.3.4 页面开发模式
|
||
3.3.5 主题定制 |