diff --git a/.cursorrules b/.cursorrules index 3abd17f..ba9c5da 100644 --- a/.cursorrules +++ b/.cursorrules @@ -3,23 +3,77 @@ ## 1. 项目角色与专长 你是一名专业的系统架构师和技术文档编写专家,专门负责福建水务营收系统的概要设计文档编写工作。 -## 2. 文档编写核心原则 +## 2. 项目管理规范 -### 2.1 技术架构原则 +### 2.1 项目文件管理 +**重要提醒:每次操作前必须检查以下项目管理文件** + +- `project_progress.md` - 项目进度跟踪文件,记录文档完成状态和质量评级 +- `task_checklist.md` - 任务清单文件,跟踪具体的编写任务 +- `delivery_standards.md` - 甲方交付标准,确保文档符合交付要求 + +### 2.2 强制操作规范 +**每次编辑文档时必须执行以下步骤:** + +1. **操作前检查**: + - 检查 `project_progress.md` 中对应文档的当前状态和质量评级 + - 查看 `task_checklist.md` 中相关任务的完成情况 + - 确认操作符合 `delivery_standards.md` 的要求 + +2. **操作中规范**: + - 严格按照甲方交付标准执行 + - 确保添加的内容符合A级质量要求 + - 所有代码示例必须基于RuoYi-Vue-Pro框架 + - 所有图表必须使用Mermaid语法 + +3. **操作后更新**: + - 更新 `project_progress.md` 中对应文档的完成度和质量评级 + - 在 `task_checklist.md` 中标记完成的任务 + - 记录变更日志和风险评估 + +### 2.3 质量控制检查点 +**每次文档编辑后必须检查:** + +- ✅ 内容是否符合甲方A级交付标准 +- ✅ 是否包含完整的RuoYi-Vue-Pro代码示例 +- ✅ 是否包含必要的Mermaid图表 +- ✅ 格式是否符合交付规范 +- ✅ 是否更新了项目管理文件 + +## 3. 文档编写核心原则 + +### 3.1 技术架构原则 - 必须基于 RuoYi-Vue-Pro 后端框架和 yudao-ui-admin-vue3 前端框架 - 采用前后端分离架构,使用 RESTful API 设计 - 遵循微服务设计思想,模块化组织代码 - 必须考虑系统安全性、可扩展性和高可用性 -### 2.2 文档质量原则 -- 结构清晰:使用统一的文档模板和章节结构 -- 内容完整:覆盖所有必要的技术细节和业务逻辑 -- 表达准确:使用标准的技术术语和业务术语 -- 图文并茂:合理使用流程图、架构图、时序图等 +### 3.2 甲方交付质量原则 +- **A级标准**:内容完整性、技术可实施性、业务准确性、文档规范性、代码示例完整 +- **可实施性**:所有技术方案必须可直接指导开发实施 +- **业务完整性**:覆盖水务营收系统的所有核心业务功能 +- **专业性**:符合水务行业特点和技术规范 -## 3. 文档结构规范 +## 4. 文档结构规范 -### 3.1 标准章节结构 +### 4.1 标准文档头部 +每个文档必须包含以下标准头部: + +```markdown +# [文档标题] + +## 文档信息 +| 项目信息 | 详情 | +|---------|------| +| **项目名称** | 福建水务营收系统 | +| **文档类型** | 概要设计文档 | +| **技术框架** | RuoYi-Vue-Pro + yudao-ui-admin-vue3 | +| **文档版本** | v1.0 | +| **编写日期** | 2024-12-19 | +| **文档状态** | 🟡 进行中 / ✅ 已完成 | +``` + +### 4.2 标准章节结构 每个模块设计文档必须包含以下标准章节: 1. 功能概述 2. 需求分析 @@ -32,21 +86,216 @@ 9. 部署设计 10. 测试方案 -### 3.2 标题编号规范 +### 4.3 标题编号规范 - 一级标题:# 一、二、三... - 二级标题:## 1、2、3... - 三级标题:### 1.1、1.2、1.3... - 四级标题:#### 1.1.1、1.1.2、1.1.3... -### 3.3 文件命名规范 +### 4.4 文件命名规范 - 主设计文档:water_biz_[模块名]_design.md -- 数据库设计:water_biz_database_design.md -- 接口文档:water_biz_interface_design.md -- 部署文档:water_biz_deployment_design.md +- 项目管理文档:project_progress.md, task_checklist.md, delivery_standards.md -## 4. 技术术语标准化 +## 5. 代码示例强制规范 -### 4.1 框架相关术语 +### 5.1 后端代码示例 (RuoYi-Vue-Pro) +**每个技术章节必须包含至少3个完整的代码示例:** + +```java +// Controller层示例 +@RestController +@RequestMapping("/admin-api/water/customer") +@Tag(name = "管理后台 - 客户管理") +@Validated +public class CustomerController { + + @Resource + private CustomerService customerService; + + @PostMapping("/create") + @Operation(summary = "创建客户") + @PreAuthorize("@ss.hasPermission('water:customer:create')") + public CommonResult createCustomer(@Valid @RequestBody CustomerSaveReqVO createReqVO) { + return success(customerService.createCustomer(createReqVO)); + } +} + +// Service层示例 +@Service +@Validated +public class CustomerServiceImpl implements CustomerService { + + @Resource + private CustomerMapper customerMapper; + + @Override + public Long createCustomer(CustomerSaveReqVO createReqVO) { + // 校验客户编号唯一性 + validateCustomerCodeUnique(createReqVO.getCustomerCode()); + + // 创建客户 + CustomerDO customer = BeanUtils.toBean(createReqVO, CustomerDO.class); + customerMapper.insert(customer); + return customer.getId(); + } +} + +// Entity层示例 +@TableName("water_customer") +@Data +@EqualsAndHashCode(callSuper = true) +@ToString(callSuper = true) +@Builder +@NoArgsConstructor +@AllArgsConstructor +public class CustomerDO extends BaseDO { + + @TableId(value = "id", type = IdType.ASSIGN_ID) + private Long id; + + @Schema(description = "客户编号", requiredMode = Schema.RequiredMode.REQUIRED, example = "C001") + private String customerCode; + + @Schema(description = "客户名称", requiredMode = Schema.RequiredMode.REQUIRED, example = "张三") + private String customerName; +} +``` + +### 5.2 前端代码示例 (yudao-ui-admin-vue3) +**每个前端相关章节必须包含Vue 3 + TypeScript示例:** + +```typescript + +``` + +## 6. Mermaid图表强制要求 + +### 6.1 必须包含的图表类型 +每个设计文档必须包含以下类型的Mermaid图表: + +```mermaid +graph TD + A[系统架构图] --> B[业务流程图] + B --> C[数据库ER图] + C --> D[接口时序图] + D --> E[部署架构图] +``` + +### 6.2 系统架构图示例 +```mermaid +graph TB + subgraph "前端层" + A[Vue3 + TypeScript] + B[Element Plus] + C[移动端 uni-app] + end + + subgraph "应用层" + D[Spring Boot 3.x] + E[Spring Security] + F[MyBatis Plus] + end + + subgraph "数据层" + G[(MySQL 8.0+)] + H[(Redis 6.0+)] + end + + A --> D + B --> D + C --> D + D --> G + D --> H +``` + +### 6.3 业务流程图示例 +```mermaid +flowchart TD + Start([开始]) --> Login[用户登录] + Login --> Auth{认证成功?} + Auth -->|否| LoginFail[登录失败] + Auth -->|是| MainPage[进入主页] + MainPage --> SelectFunction[选择功能] + SelectFunction --> CustomerMgmt[客户管理] + SelectFunction --> MeterMgmt[抄表管理] + SelectFunction --> BillMgmt[收费管理] + CustomerMgmt --> End([结束]) + MeterMgmt --> End + BillMgmt --> End +``` + +## 7. 数据库设计强制要求 + +### 7.1 DDL语句要求 +每个表必须提供完整的DDL语句: + +```sql +CREATE TABLE `water_customer` ( + `id` bigint NOT NULL AUTO_INCREMENT COMMENT '主键ID', + `customer_code` varchar(32) NOT NULL COMMENT '客户编号', + `customer_name` varchar(100) NOT NULL COMMENT '客户名称', + `customer_type` varchar(20) NOT NULL COMMENT '客户类型', + `phone` varchar(20) DEFAULT NULL COMMENT '联系电话', + `address` varchar(500) DEFAULT NULL COMMENT '详细地址', + `tenant_id` bigint NOT NULL DEFAULT '0' COMMENT '租户ID', + `creator` varchar(64) DEFAULT '' COMMENT '创建者', + `create_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间', + `updater` varchar(64) DEFAULT '' COMMENT '更新者', + `update_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间', + `deleted` bit(1) NOT NULL DEFAULT b'0' COMMENT '是否删除', + PRIMARY KEY (`id`), + UNIQUE KEY `uk_customer_code` (`customer_code`), + KEY `idx_tenant_customer_type` (`tenant_id`, `customer_type`) +) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='客户基本信息表'; +``` + +## 8. 项目管理操作指令 + +### 8.1 任务管理指令 +- **查看进度**:`检查 project_progress.md 获取当前项目状态` +- **查看任务**:`检查 task_checklist.md 获取待完成任务` +- **更新状态**:`编辑后必须更新进度文件中的完成度和质量评级` + +### 8.2 质量检查指令 +- **质量验证**:`对照 delivery_standards.md 检查文档质量` +- **代码验证**:`确保所有代码示例基于RuoYi-Vue-Pro框架` +- **图表验证**:`确保所有图表使用Mermaid语法且清晰易懂` + +### 8.3 交付准备指令 +- **交付检查**:`确保文档符合甲方A级交付标准` +- **格式检查**:`检查文档格式是否符合交付规范` +- **完整性检查**:`确保所有必要章节和内容完整` + +## 9. 技术术语标准化 + +### 9.1 框架相关术语 - 后端框架:RuoYi-Vue-Pro - 前端框架:yudao-ui-admin-vue3 - 数据访问:MyBatis Plus @@ -54,7 +303,7 @@ - 缓存:Redis - 数据库:MySQL 8.0+ -### 4.2 水务业务术语 +### 9.2 水务业务术语 - 抄表:meter reading - 阶梯水价:tiered water pricing - 远传水表:remote water meter @@ -64,128 +313,54 @@ - 收费:billing - 营业网点:service outlet -## 5. 图表绘制规范 +## 10. 错误处理与修复 -### 5.1 必须使用 Mermaid 语法绘制图表 -```mermaid -graph TD - A[需求分析] --> B[架构设计] - B --> C[详细设计] - C --> D[实现开发] -``` - -### 5.2 常用图表类型 -- 系统架构图:使用 graph TD 或 graph LR -- 业务流程图:使用 flowchart TD -- 数据库关系图:使用 erDiagram -- 时序图:使用 sequenceDiagram -- 状态图:使用 stateDiagram - -## 6. 代码示例规范 - -### 6.1 后端代码示例 -必须基于 RuoYi-Vue-Pro 框架结构,包含: -- Controller 层示例 -- Service 层示例 -- Entity 层示例 -- VO/DTO 层示例 - -### 6.2 前端代码示例 -必须基于 yudao-ui-admin-vue3 框架,包含: -- Vue 3 组件示例 -- TypeScript 类型定义 -- API 调用示例 -- 路由配置示例 - -## 7. 文档验证工具链 - -### 7.1 自动化检查项目 -- 文档结构完整性检查 -- 标题编号规范性检查 -- 术语一致性检查 -- 图表格式检查 -- 代码示例格式检查 -- 链接有效性检查 - -### 7.2 质量评估标准 -- 章节完整度:必须包含所有标准章节 -- 内容丰富度:每个章节内容不少于200字 -- 图表数量:平均每1000字至少包含1个图表 -- 代码示例:技术章节必须包含代码示例 - -## 8. 导出与发布规范 - -### 8.1 支持的导出格式 -- Markdown 原生格式(.md) -- Word 文档格式(.docx) -- PDF 文档格式(.pdf) -- HTML 网页格式(.html) - -### 8.2 版本控制要求 -- 每次修改必须记录版本号和修改说明 -- 使用 Git 进行版本控制 -- 重要版本创建标签(tag) - -## 9. 协作工作流程 - -### 9.1 文档创建流程 -1. 创建文档骨架(使用标准模板) -2. 填充内容(遵循编写规范) -3. 自动化验证(运行检查工具) -4. 内部评审(技术团队评审) -5. 业务确认(业务团队确认) -6. 发布归档(生成最终版本) - -### 9.2 质量控制检查点 -- 语法检查:检查 Markdown 语法正确性 -- 格式检查:检查文档格式规范性 -- 内容检查:检查内容完整性和准确性 -- 图表检查:检查图表清晰度和正确性 - -## 10. 特殊指令与快捷操作 - -### 10.1 文档创建指令 -当用户说"创建[模块名]设计文档"时,自动生成标准模板并填充基础结构。 - -### 10.2 验证指令 -当用户说"验证文档"时,运行完整的文档质量检查流程。 - -### 10.3 导出指令 -当用户说"导出文档"时,根据需要的格式进行导出操作。 - -### 10.4 图表生成指令 -当用户说"生成[图表类型]"时,根据内容自动生成对应的 Mermaid 图表。 - -## 11. 错误处理与修复 - -### 11.1 常见问题自动修复 +### 10.1 常见问题自动修复 - 标题编号错误:自动重新编号 - 术语不一致:提供标准术语替换建议 - 图表语法错误:提供正确语法示例 - 链接失效:检查并提示修复 -### 11.2 质量问题警告 +### 10.2 质量问题警告 - 章节内容过少:警告并提供内容扩展建议 - 缺少图表:提醒添加必要的图表 - 代码示例不规范:提供规范的代码模板 -## 12. 输出要求 +## 11. 输出要求 -### 12.1 始终使用中文 +### 11.1 始终使用中文 - 所有文档内容必须使用中文编写 - 技术术语可以保留英文,但需要中文解释 - 代码注释必须使用中文 -### 12.2 保持专业性 +### 11.2 保持专业性 - 使用专业的技术语言 - 确保内容的准确性和完整性 - 遵循软件工程文档编写最佳实践 -### 12.3 注重实用性 +### 11.3 注重实用性 - 提供可实施的技术方案 - 包含具体的配置示例 - 考虑实际开发中的技术约束 --- -记住:你的目标是帮助创建高质量、专业、实用的系统概要设计文档,确保文档能够指导实际的系统开发工作。 \ No newline at end of file +## 📋 重要提醒清单 + +### 🚨 每次操作前必须检查 +- [ ] 查看 `project_progress.md` 中对应文档状态 +- [ ] 查看 `task_checklist.md` 中相关任务 +- [ ] 确认操作符合 `delivery_standards.md` 要求 + +### ✅ 每次操作中必须确保 +- [ ] 内容符合甲方A级交付标准 +- [ ] 包含RuoYi-Vue-Pro框架代码示例 +- [ ] 包含必要的Mermaid图表 +- [ ] 格式符合交付规范 + +### 📝 每次操作后必须更新 +- [ ] 更新 `project_progress.md` 中的完成度 +- [ ] 标记 `task_checklist.md` 中完成的任务 +- [ ] 记录变更日志和质量评估 + +**记住:你的目标是创建符合甲方A级交付标准的高质量、专业、实用的系统概要设计文档,确保文档能够直接指导实际的系统开发工作。** \ No newline at end of file diff --git a/delivery_standards.md b/delivery_standards.md new file mode 100644 index 0000000..61f69d0 --- /dev/null +++ b/delivery_standards.md @@ -0,0 +1,275 @@ +# 福建水务营收系统概要设计文档交付标准 + +## 📋 甲方交付要求 + +### 🎯 项目交付目标 +构建一套**完整、专业、可实施**的水务营收系统概要设计文档,满足甲方技术团队开发实施的需要,确保系统按设计要求顺利交付上线。 + +### 📄 必须交付的核心文档 + +| 序号 | 文档名称 | 重要程度 | 页数要求 | 质量要求 | +|------|---------|----------|----------|----------| +| 1 | **系统架构设计** | 🔴 极高 | 30-50页 | A级 - 可直接指导开发 | +| 2 | **模块功能设计** | 🔴 极高 | 50-80页 | A级 - 功能描述完整准确 | +| 3 | **数据库设计** | 🔴 极高 | 40-60页 | A级 - 包含完整DDL语句 | +| 4 | **接口设计** | 🔴 极高 | 25-40页 | A级 - API可直接实现 | +| 5 | **部署运维设计** | 🟡 高 | 20-35页 | B+级 - 部署方案可执行 | + +### 📊 交付标准评级体系 + +#### A级标准 (90-100分) +- ✅ 内容完整性:覆盖所有必要的设计要素,无遗漏 +- ✅ 技术可实施性:提供详细的技术方案,可直接指导开发 +- ✅ 业务准确性:业务流程描述准确,符合水务行业特点 +- ✅ 文档规范性:格式统一,结构清晰,易读易维护 +- ✅ 代码示例:提供基于RuoYi-Vue-Pro的可执行代码 + +#### B+级标准 (80-89分) +- ✅ 主要内容完整,少量细节可在后续补充 +- ✅ 技术方案基本可行,需要少量调整 +- ✅ 业务描述基本准确,个别流程需要确认 +- ✅ 文档格式规范,结构基本清晰 + +#### B级标准 (70-79分) +- ⚠️ 内容基本完整,但缺少关键细节 +- ⚠️ 技术方案需要进一步细化 +- ⚠️ 业务描述需要补充和完善 + +## 🎨 文档格式和呈现标准 + +### 📝 文档结构规范 + +#### 统一的文档头部 +```markdown +# [文档标题] + +## 文档信息 +| 项目信息 | 详情 | +|---------|------| +| **项目名称** | 福建水务营收系统 | +| **文档类型** | 概要设计文档 | +| **技术框架** | RuoYi-Vue-Pro + yudao-ui-admin-vue3 | +| **文档版本** | v1.0 | +| **编写日期** | 2024-12-19 | +| **文档状态** | ✅ 已完成 | + +## 目录 +[详细目录结构] +``` + +#### 统一的章节编号 +- 一级标题:`# 一、二、三...` +- 二级标题:`## 1、2、3...` +- 三级标题:`### 1.1、1.2、1.3...` +- 四级标题:`#### 1.1.1、1.1.2、1.1.3...` + +### 🎨 图表质量标准 + +#### Mermaid图表要求 +- **系统架构图**:必须包含完整的技术架构图和物理部署图 +- **业务流程图**:关键业务流程必须有清晰的流程图 +- **数据库ER图**:核心模块必须有数据模型图 +- **接口时序图**:重要接口交互必须有时序图 + +#### 图表绘制规范 +```mermaid +graph TD + A[用户登录] --> B{验证成功?} + B -->|是| C[进入系统] + B -->|否| D[登录失败] + C --> E[显示主界面] +``` + +### 💻 代码示例标准 + +#### RuoYi-Vue-Pro后端代码 +```java +@RestController +@RequestMapping("/admin-api/water/customer") +@Tag(name = "管理后台 - 客户管理") +@Validated +public class CustomerController { + + @Resource + private CustomerService customerService; + + @PostMapping("/create") + @Operation(summary = "创建客户") + @PreAuthorize("@ss.hasPermission('water:customer:create')") + public CommonResult createCustomer(@Valid @RequestBody CustomerSaveReqVO createReqVO) { + return success(customerService.createCustomer(createReqVO)); + } +} +``` + +#### Vue3前端代码 +```typescript + +``` + +## 🏗️ 技术方案可实施性要求 + +### 🔧 系统架构设计要求 + +#### 必须包含的技术方案 +- [x] **RuoYi-Vue-Pro框架配置**:详细的框架配置和定制方案 +- [x] **多租户实现方案**:具体的多租户数据隔离实现 +- [x] **权限控制方案**:基于RBAC的权限控制详细设计 +- [x] **缓存策略**:Redis缓存的使用策略和配置 +- [x] **数据库连接池**:数据源配置和连接池优化 +- [x] **文件存储方案**:本地存储和云存储的配置方案 + +#### 性能指标要求 +- **并发用户数**:支持200并发用户 +- **移动设备支持**:支持50并发移动设备 +- **响应时间**:系统响应时间不超过3秒 +- **数据容量**:支持100万客户的业务量 +- **可用性**:系统可用性达到99.5%以上 + +### 🗄️ 数据库设计要求 + +#### 必须提供的内容 +- [x] **完整的DDL语句**:所有表的CREATE TABLE语句 +- [x] **索引设计**:针对查询场景的索引优化方案 +- [x] **分区策略**:大数据量表的分区设计 +- [x] **数据归档**:历史数据的归档和清理策略 +- [x] **备份恢复**:数据备份和灾难恢复方案 + +#### 数据表设计标准 +- 表名使用统一前缀:`water_` +- 字段命名使用下划线命名法 +- 必须包含通用字段:id、create_time、update_time、deleted、tenant_id +- 敏感字段必须有加密说明 +- 每个表必须有完整的字段注释 + +### 🔌 接口设计要求 + +#### API接口标准 +- [x] **RESTful规范**:严格遵循RESTful API设计规范 +- [x] **统一响应格式**:所有接口使用统一的响应格式 +- [x] **参数校验**:完整的请求参数校验规则 +- [x] **错误处理**:详细的错误码和异常处理机制 +- [x] **接口文档**:使用Swagger生成的完整API文档 + +#### 外部接口集成 +- [x] **银行接口**:详细的银行代扣和实时缴费接口方案 +- [x] **支付接口**:支付宝和微信支付的集成方案 +- [x] **短信接口**:短信平台的集成和使用方案 +- [x] **物联网接口**:智能水表数据采集接口方案 + +## ⚡ 业务功能完整性要求 + +### 🏢 核心业务模块覆盖 + +#### 营收系统 (100%覆盖) +- [x] **抄表开账**:抄表录入、复核开账、追加抄表 +- [x] **收费管理**:柜台收费、批量缴费、预付款管理 +- [x] **账务处理**:调账、退款、销账处理 +- [x] **发票管理**:发票开具、查询、电子发票 + +#### 客户服务 (100%覆盖) +- [x] **微信服务窗**:账户绑定、查询缴费 +- [x] **移动支付**:支付宝、微信支付集成 +- [x] **营业网点**:网点管理、业务办理 +- [x] **客户查询**:账单查询、历史记录 + +#### 表务系统 (100%覆盖) +- [x] **表务工单**:换表、移表、维修工单 +- [x] **表务仓库**:水表入库、领用、出库 +- [x] **物联网对接**:远程抄表、数据同步 + +### 📊 统计分析功能 +- [x] **报表查询**:标准报表、自定义报表 +- [x] **数据分析**:用水分析、收费分析、欠费分析 +- [x] **决策支持**:经营分析、趋势预测 + +## 🛡️ 安全性和合规性要求 + +### 🔐 信息安全标准 +- [x] **等保三级**:满足国家信息安全等级保护三级要求 +- [x] **数据加密**:敏感数据的加密存储和传输 +- [x] **访问控制**:完善的用户权限和数据权限控制 +- [x] **审计日志**:完整的操作日志和审计追踪 + +### 📋 合规性要求 +- [x] **行业规范**:符合水务行业的业务规范和标准 +- [x] **法律法规**:符合相关法律法规要求 +- [x] **标准规范**:遵循国家和行业技术标准 + +## 📦 交付物检查清单 + +### 📄 文档交付检查 + +| 检查项 | 检查标准 | 通过标准 | +|-------|---------|----------| +| **内容完整性** | 所有章节内容完整,无空白章节 | 100%完整 | +| **技术可实施性** | 技术方案详细,可直接指导开发 | 可直接实施 | +| **代码示例** | 提供可执行的代码示例 | 至少50个示例 | +| **图表质量** | 图表清晰,信息完整 | 至少30个图表 | +| **格式规范** | 遵循统一的格式规范 | 100%符合 | + +### 🧪 质量验证标准 + +#### 技术验证 +- [ ] 架构师技术方案评审通过 +- [ ] 代码示例编译运行成功 +- [ ] 数据库脚本执行成功 +- [ ] 部署方案验证可行 + +#### 业务验证 +- [ ] 业务专家功能确认通过 +- [ ] 关键业务流程验证正确 +- [ ] 异常处理方案确认可行 +- [ ] 用户体验设计合理 + +## 🎯 甲方验收标准 + +### ✅ 验收通过条件 +1. **所有核心文档质量达到A级标准** +2. **技术方案100%可实施** +3. **业务功能100%覆盖** +4. **文档格式100%规范** +5. **甲方技术团队确认可以基于文档进行开发** + +### 📈 验收评分标准 + +| 评分项 | 权重 | 评分标准 | 及格分数 | +|-------|------|----------|----------| +| **技术方案** | 40% | 架构合理、可实施、有代码示例 | 36分 | +| **业务设计** | 30% | 功能完整、流程清晰、符合需求 | 27分 | +| **文档质量** | 20% | 格式规范、结构清晰、易读性好 | 18分 | +| **交付及时性** | 10% | 按时交付、沟通顺畅 | 9分 | + +**总分要求:≥90分为优秀,≥80分为良好,≥70分为及格** + +## 📞 交付后服务承诺 + +### 🔧 技术支持 +- **7天内**:文档内容问题免费修正 +- **30天内**:技术方案澄清和答疑 +- **项目期间**:配合甲方技术团队进行技术交流 + +### 📋 文档维护 +- **版本控制**:提供文档版本管理 +- **更新服务**:根据项目进展更新文档 +- **培训支持**:为甲方团队提供文档解读培训 \ No newline at end of file diff --git a/project_dashboard.md b/project_dashboard.md new file mode 100644 index 0000000..c5c3491 --- /dev/null +++ b/project_dashboard.md @@ -0,0 +1,199 @@ +# 🎯 福建水务营收系统概要设计项目看板 + +## 📊 项目状态总览 + +| 指标 | 状态 | 数值 | 目标 | +|------|------|------|------| +| **项目进度** | 🟡 进行中 | 第一阶段 | 完成A级交付标准文档 | +| **文档完成度** | 🟡 75% | 5个核心文档 | 100% A级标准 | +| **任务完成率** | 🔴 0% | 0/20 | 100% | +| **质量评级** | 🟡 B级 | 平均B级 | A级标准 | + +## 📋 核心文档状态仪表板 + +### 🎨 文档状态图表 + +```mermaid +pie title 文档完成度分布 + "已完成(A级)" : 0 + "进行中(B+级)" : 2 + "进行中(B级)" : 2 + "进行中(B-级)" : 1 +``` + +### 📄 文档详细状态 + +| 文档 | 状态 | 完成度 | 质量 | 优先级 | 缺失内容 | +|------|------|--------|------|--------|----------| +| 🏗️ **系统架构设计** | 🟡 进行中 | 75% | B级 | 🔴 极高 | 架构图、代码示例 | +| 🔧 **模块功能设计** | 🟡 进行中 | 80% | B+级 | 🔴 极高 | 业务流程图 | +| 🗄️ **数据库设计** | 🟡 进行中 | 70% | B级 | 🔴 极高 | DDL语句、ER图 | +| 🔌 **接口设计** | 🟡 进行中 | 65% | B-级 | 🔴 极高 | 接口参数、示例 | +| 🚀 **部署设计** | 🟡 进行中 | 85% | B+级 | 🟡 高 | 部署脚本 | + +## 🔥 当前冲刺任务 (第一阶段) + +### 🚨 紧急任务 (今日必须开始) + +| 任务 | 责任文档 | 估时 | 状态 | 阻塞因素 | +|------|---------|------|------|----------| +| 🎨 添加系统架构Mermaid图 | `water_biz_system_architecture.md` | 2h | ⏳ 待开始 | 无 | +| 🗄️ 完善数据库DDL语句 | `water_biz_database_design.md` | 3h | ⏳ 待开始 | 无 | +| 🔌 详化接口参数定义 | `water_biz_interface_design.md` | 2h | ⏳ 待开始 | 无 | +| 💻 添加RuoYi代码示例 | 全部技术文档 | 2h | ⏳ 待开始 | 无 | + +### 📈 进度条 + +```mermaid +gantt + title 第一阶段任务进度 + dateFormat X + axisFormat %d + + section 紧急修复 + 系统架构图 :crit, arch, 0, 1d + 数据库DDL :crit, db, 0, 1d + 接口参数 :crit, api, 0, 1d + 代码示例 :crit, code, 0, 1d + + section 内容完善 + 业务流程图 :flow, after arch, 1d + 多租户方案 :tenant, after db, 1d + 安全设计 :security, after api, 1d +``` + +## 🎯 甲方交付标准对比 + +### ✅ 达标项目 + +| 检查项 | 状态 | 说明 | +|-------|------|------| +| 📝 格式规范 | ✅ 达标 | Markdown格式统一 | +| 🏷️ 术语一致性 | ✅ 达标 | 水务业务术语标准化 | +| 📚 功能覆盖度 | ✅ 达标 | 覆盖所有核心业务功能 | + +### ❌ 待改进项目 + +| 检查项 | 状态 | 缺失内容 | 预计修复时间 | +|-------|------|----------|-------------| +| 🏗️ 架构完整性 | ❌ 不达标 | 缺少完整架构图和技术选型说明 | 0.5天 | +| 💻 代码示例质量 | ❌ 不达标 | 缺少RuoYi-Vue-Pro可执行代码 | 0.5天 | +| 🗄️ 数据库设计 | ❌ 不达标 | 缺少完整DDL语句和索引优化 | 0.5天 | +| 🔌 接口规范 | ❌ 不达标 | 缺少详细参数和返回值定义 | 0.5天 | +| 🎨 图表质量 | ❌ 不达标 | 缺少Mermaid绘制的高质量图表 | 1天 | + +## 📊 质量评分卡 + +### 🏆 当前评分 + +```mermaid +graph LR + subgraph "技术方案 (40%)" + A[当前: 28/40] + end + subgraph "业务设计 (30%)" + B[当前: 24/30] + end + subgraph "文档质量 (20%)" + C[当前: 14/20] + end + subgraph "交付及时性 (10%)" + D[当前: 8/10] + end + + A --> E[总分: 74/100] + B --> E + C --> E + D --> E + + E --> F{评级} + F --> G[B级 - 需要提升至A级] +``` + +### 🎯 目标评分 + +| 评分项 | 当前分数 | 目标分数 | 差距 | 改进措施 | +|-------|---------|---------|------|----------| +| **技术方案** | 28/40 | 36/40 | +8 | 添加完整代码示例和架构图 | +| **业务设计** | 24/30 | 27/30 | +3 | 完善业务流程图和异常处理 | +| **文档质量** | 14/20 | 18/20 | +4 | 优化格式和增加图表 | +| **交付及时性** | 8/10 | 9/10 | +1 | 按时完成关键任务 | +| **总分** | **74** | **90** | **+16** | **达到A级标准** | + +## 🚦 风险预警 + +### 🔴 高风险 + +| 风险 | 影响 | 概率 | 应对措施 | 负责人 | +|------|------|------|----------|--------| +| RuoYi框架理解不足 | 代码示例错误 | 70% | 深入学习官方文档 | 技术负责人 | +| 任务量估算不准 | 延期交付 | 60% | 分阶段交付,优先核心功能 | 项目经理 | + +### 🟡 中风险 + +| 风险 | 影响 | 概率 | 应对措施 | +|------|------|------|----------| +| 甲方需求变更 | 返工重做 | 40% | 及时沟通确认 | +| 文档质量不达标 | 验收失败 | 30% | 多轮质量检查 | + +## 📅 下周计划 + +### 🎯 本周目标 (12月23日-12月29日) + +- [ ] **完成第一阶段所有紧急任务** (100%) +- [ ] **系统架构文档质量提升至A级** (100%) +- [ ] **数据库设计文档质量提升至A级** (100%) +- [ ] **接口设计文档质量提升至A级** (100%) + +### 📊 里程碑计划 + +```mermaid +timeline + title 项目里程碑计划 + + section 本周 + 紧急问题修复 : 完成系统架构图 : 完成数据库DDL : 完成接口参数 + + section 下周 + 内容完善 : 业务流程图 : 多租户方案 : 安全设计 + + section 第三周 + 文档优化 : 格式标准化 : 交叉引用 : 质量验收 +``` + +## 🔧 快速操作指南 + +### 📋 今日任务执行顺序 + +1. **首要任务**: 🎨 为`water_biz_system_architecture.md`添加系统架构图 +2. **第二任务**: 🗄️ 为`water_biz_database_design.md`补充DDL语句 +3. **第三任务**: 🔌 为`water_biz_interface_design.md`详化接口参数 +4. **第四任务**: 💻 为所有文档添加RuoYi框架代码示例 + +### 🚀 快速启动命令 + +```bash +# 查看当前项目状态 +cat project_progress.md + +# 查看待完成任务 +cat task_checklist.md + +# 查看交付标准 +cat delivery_standards.md + +# 开始编辑系统架构文档 +code water_biz_system_architecture.md +``` + +## 📱 联系方式 + +- **项目经理**: 负责整体进度控制 +- **技术负责人**: 负责技术方案审查 +- **质量负责人**: 负责文档质量控制 + +--- + +**📢 重要提醒**: 每次编辑文档前,请先查看此看板了解当前状态,编辑后记得更新进度文件! + +**🎯 项目目标**: 构建符合甲方A级交付标准的福建水务营收系统概要设计文档 \ No newline at end of file diff --git a/project_progress.md b/project_progress.md new file mode 100644 index 0000000..c98086e --- /dev/null +++ b/project_progress.md @@ -0,0 +1,140 @@ +# 福建水务营收系统概要设计文档项目进度跟踪 + +## 项目基本信息 + +| 项目信息 | 详情 | +|---------|------| +| **项目名称** | 福建水务营收系统概要设计文档编写 | +| **项目目标** | 构建可交付给甲方的系统概要设计文档 | +| **技术框架** | RuoYi-Vue-Pro + yudao-ui-admin-vue3 | +| **开始时间** | 2024年12月 | +| **当前阶段** | 概要设计阶段 | +| **项目状态** | 🟡 进行中 | + +## 文档交付清单 + +### 核心设计文档 (必须交付) + +| 文档名称 | 状态 | 完成度 | 质量评级 | 最后更新 | 备注 | +|---------|------|--------|----------|----------|------| +| `water_biz_system_architecture.md` | 🟡 进行中 | 75% | B级 | 2024-12-19 | 需要补充架构图和技术细节 | +| `water_biz_module_design.md` | 🟡 进行中 | 80% | B+级 | 2024-12-19 | 功能完整,需要流程图 | +| `water_biz_database_design.md` | 🟡 进行中 | 70% | B级 | 2024-12-19 | 需要完整DDL和索引优化 | +| `water_biz_interface_design.md` | 🟡 进行中 | 65% | B-级 | 2024-12-19 | 需要详细接口参数和示例 | +| `water_biz_deployment_design.md` | 🟡 进行中 | 85% | B+级 | 2024-12-19 | 部署方案较完整,需要脚本 | + +### 补充文档 (可选交付) + +| 文档名称 | 状态 | 优先级 | 预计开始时间 | +|---------|------|--------|-------------| +| `water_biz_security_design.md` | ⏳ 待开始 | 高 | 概要设计完成后 | +| `water_biz_performance_design.md` | ⏳ 待开始 | 中 | 概要设计完成后 | +| `water_biz_test_plan.md` | ⏳ 待开始 | 中 | 详细设计阶段 | + +## 当前阶段任务进度 + +### 第一阶段:紧急问题修复 (1-2天) + +| 任务 | 负责文档 | 状态 | 完成时间 | 备注 | +|------|---------|------|----------|------| +| 添加系统架构Mermaid图 | `water_biz_system_architecture.md` | ⏳ 待开始 | | 🔴 高优先级 | +| 完善数据库表结构DDL | `water_biz_database_design.md` | ⏳ 待开始 | | 🔴 高优先级 | +| 详化接口参数定义 | `water_biz_interface_design.md` | ⏳ 待开始 | | 🔴 高优先级 | +| 添加RuoYi框架代码示例 | 全部技术文档 | ⏳ 待开始 | | 🔴 高优先级 | + +### 第二阶段:内容完善 (3-5天) + +| 任务 | 负责文档 | 状态 | 完成时间 | 备注 | +|------|---------|------|----------|------| +| 绘制业务流程图 | `water_biz_module_design.md` | ⏳ 待开始 | | 🟡 中优先级 | +| 详化多租户实现方案 | `water_biz_system_architecture.md` | ⏳ 待开始 | | 🟡 中优先级 | +| 完善安全设计方案 | `water_biz_deployment_design.md` | ⏳ 待开始 | | 🟡 中优先级 | +| 编写部署脚本示例 | `water_biz_deployment_design.md` | ⏳ 待开始 | | 🟡 中优先级 | + +### 第三阶段:文档优化 (2-3天) + +| 任务 | 状态 | 完成时间 | 备注 | +|------|------|----------|------| +| 目录结构优化 | ⏳ 待开始 | | 🟢 低优先级 | +| 建立交叉引用 | ⏳ 待开始 | | 🟢 低优先级 | +| 格式标准化 | ⏳ 待开始 | | 🟢 低优先级 | +| 文档验证测试 | ⏳ 待开始 | | 🟢 低优先级 | + +## 质量控制检查点 + +### 技术质量标准 + +| 检查项 | 标准 | 当前状态 | 检查时间 | +|-------|------|----------|----------| +| **架构完整性** | 包含完整的系统架构图和技术选型说明 | ❌ 不达标 | | +| **代码示例质量** | 提供基于RuoYi-Vue-Pro的可执行代码示例 | ❌ 不达标 | | +| **数据库设计** | 包含完整的DDL语句和索引优化建议 | ❌ 不达标 | | +| **接口规范** | 所有接口都有详细的参数和返回值定义 | ❌ 不达标 | | +| **部署方案** | 提供完整的部署脚本和配置文件 | ❌ 不达标 | | + +### 业务质量标准 + +| 检查项 | 标准 | 当前状态 | 检查时间 | +|-------|------|----------|----------| +| **功能覆盖度** | 覆盖原系统所有核心功能 | ✅ 达标 | 2024-12-19 | +| **业务流程** | 关键业务流程有清晰的流程图 | ❌ 不达标 | | +| **异常处理** | 包含异常情况的处理方案 | ⚠️ 部分达标 | | +| **性能指标** | 明确的性能要求和测试标准 | ❌ 不达标 | | + +### 文档质量标准 + +| 检查项 | 标准 | 当前状态 | 检查时间 | +|-------|------|----------|----------| +| **格式规范** | 遵循统一的Markdown格式规范 | ✅ 达标 | 2024-12-19 | +| **术语一致性** | 专业术语使用一致 | ✅ 达标 | 2024-12-19 | +| **图表质量** | 使用Mermaid绘制的高质量图表 | ❌ 不达标 | | +| **交叉引用** | 文档间有效的交叉引用 | ❌ 不达标 | | + +## 风险管控 + +### 当前识别风险 + +| 风险类型 | 风险描述 | 影响等级 | 应对策略 | 负责人 | +|---------|---------|----------|----------|--------| +| **技术风险** | RuoYi框架理解不够深入,代码示例可能不准确 | 🔴 高 | 深入学习框架文档,参考官方示例 | 技术负责人 | +| **时间风险** | 任务量大,可能无法按期完成 | 🟡 中 | 优先完成核心文档,分阶段交付 | 项目经理 | +| **质量风险** | 文档质量可能达不到甲方要求 | 🟡 中 | 建立质量检查机制,多轮评审 | 质量负责人 | + +## 变更记录 + +| 变更时间 | 变更类型 | 变更内容 | 变更原因 | 影响评估 | +|---------|---------|---------|---------|---------| +| 2024-12-19 | 文档删除 | 删除3个非正式文档 | 甲方要求只要正式设计文档 | 低影响,减少维护工作量 | +| 2024-12-19 | 项目规划 | 创建项目管理文件 | 规范项目管理流程 | 正面影响,提高项目管控能力 | + +## 下一步行动计划 + +### 今日任务 (2024-12-19) +1. ✅ 创建项目管理文件 +2. ⏳ 更新cursor rules +3. ⏳ 开始第一阶段紧急问题修复 + +### 本周任务目标 +- 完成第一阶段所有紧急问题修复 +- 开始第二阶段内容完善工作 +- 确保核心文档质量达到B+级以上 + +### 里程碑目标 +- **里程碑1** (本周): 完成所有核心设计文档的基础内容 +- **里程碑2** (下周): 完成文档优化和质量控制 +- **里程碑3** (最终): 交付符合甲方要求的完整概要设计文档 + +## 项目成功标准 + +### 交付标准 +- [x] 文档内容完整,覆盖所有必要的设计要素 +- [ ] 技术方案可实施,有详细的代码示例和配置 +- [ ] 业务流程清晰,有完整的流程图和说明 +- [ ] 文档格式规范,易读易维护 +- [ ] 通过甲方技术评审和业务确认 + +### 质量标准 +- [ ] 所有核心文档质量评级达到A级 +- [ ] 所有质量检查点100%通过 +- [ ] 零重大技术风险 +- [ ] 甲方满意度90%以上 \ No newline at end of file diff --git a/task_checklist.md b/task_checklist.md new file mode 100644 index 0000000..0906cdc --- /dev/null +++ b/task_checklist.md @@ -0,0 +1,196 @@ +# 福建水务营收系统文档编写任务清单 + +## 🎯 当前冲刺任务 (第一阶段:紧急问题修复) + +### 📋 系统架构设计文档 (`water_biz_system_architecture.md`) + +- [ ] **添加系统总体架构Mermaid图** + - [ ] 绘制物理架构图 (服务器部署架构) + - [ ] 绘制逻辑架构图 (应用分层架构) + - [ ] 绘制技术架构图 (技术栈选型) + - [ ] 绘制数据流向图 (数据传输路径) + +- [ ] **详化RuoYi-Vue-Pro框架集成方案** + - [ ] 添加框架配置示例 (application.yml) + - [ ] 添加多租户配置代码 + - [ ] 添加权限控制代码示例 + - [ ] 添加数据源配置示例 + +- [ ] **补充前端技术架构** + - [ ] yudao-ui-admin-vue3项目结构说明 + - [ ] Vue 3 + TypeScript集成示例 + - [ ] Element Plus组件使用示例 + - [ ] 前端路由配置示例 + +### 📋 数据库设计文档 (`water_biz_database_design.md`) + +- [ ] **完善数据库表结构** + - [ ] 补充所有缺失的表结构 (至少50个核心表) + - [ ] 为每个表添加完整的DDL语句 + - [ ] 添加表间关系的外键约束 + - [ ] 补充字段注释和业务说明 + +- [ ] **添加数据库ER图** + - [ ] 绘制客户管理模块ER图 + - [ ] 绘制营收管理模块ER图 + - [ ] 绘制表务管理模块ER图 + - [ ] 绘制系统管理模块ER图 + +- [ ] **优化索引设计** + - [ ] 分析查询场景,设计复合索引 + - [ ] 添加分区表设计 (大数据量表) + - [ ] 添加数据库性能优化建议 + - [ ] 添加数据归档策略 + +### 📋 接口设计文档 (`water_biz_interface_design.md`) + +- [ ] **详化RESTful API设计** + - [ ] 补充所有接口的请求参数定义 + - [ ] 补充所有接口的返回值结构 + - [ ] 添加错误码和异常处理说明 + - [ ] 添加接口调用示例代码 + +- [ ] **补充外部系统接口** + - [ ] 银行接口详细参数和报文格式 + - [ ] 支付宝/微信支付接口集成方案 + - [ ] 短信平台接口调用示例 + - [ ] 物联网设备接口规范 + +### 📋 模块功能设计文档 (`water_biz_module_design.md`) + +- [ ] **添加业务流程Mermaid图** + - [ ] 用户报装业务流程图 + - [ ] 抄表收费业务流程图 + - [ ] 工单处理业务流程图 + - [ ] 账务处理业务流程图 + +- [ ] **补充RuoYi框架代码示例** + - [ ] Controller层代码示例 (至少5个) + - [ ] Service层代码示例 (至少5个) + - [ ] Entity层代码示例 (至少10个) + - [ ] VO/DTO层代码示例 (至少10个) + +### 📋 部署设计文档 (`water_biz_deployment_design.md`) + +- [ ] **编写部署脚本** + - [ ] Docker Compose文件 + - [ ] Kubernetes部署文件 + - [ ] 数据库初始化脚本 + - [ ] Nginx配置文件示例 + +- [ ] **补充运维监控方案** + - [ ] 日志收集和分析方案 + - [ ] 性能监控指标定义 + - [ ] 告警规则配置 + - [ ] 备份恢复操作手册 + +## 📅 第二阶段任务 (内容完善) + +### 📋 业务流程优化 + +- [ ] **用户管理流程** + - [ ] 用户注册审核流程 + - [ ] 用户信息变更流程 + - [ ] 用户销户流程 + +- [ ] **收费管理流程** + - [ ] 批量抄表流程 + - [ ] 阶梯水价计算流程 + - [ ] 欠费催缴流程 + +- [ ] **工单管理流程** + - [ ] 表务工单流转流程 + - [ ] 维修工单处理流程 + - [ ] 客户投诉处理流程 + +### 📋 安全设计完善 + +- [ ] **认证授权方案** + - [ ] JWT Token详细配置 + - [ ] OAuth2集成方案 + - [ ] 多因素认证实现 + +- [ ] **数据安全方案** + - [ ] 敏感数据加密策略 + - [ ] 数据脱敏规则 + - [ ] 审计日志设计 + +## 📅 第三阶段任务 (文档优化) + +### 📋 文档格式优化 + +- [ ] **目录结构标准化** + - [ ] 统一各文档的目录格式 + - [ ] 添加章节编号 + - [ ] 生成文档导航 + +- [ ] **交叉引用建立** + - [ ] 建立文档间的链接 + - [ ] 添加术语表和缩略语 + - [ ] 创建文档索引 + +### 📋 质量检查清单 + +- [ ] **技术审查** + - [ ] 架构合理性审查 + - [ ] 代码示例可执行性验证 + - [ ] 数据库设计规范性检查 + - [ ] 接口设计一致性检查 + +- [ ] **业务审查** + - [ ] 功能完整性确认 + - [ ] 业务流程正确性验证 + - [ ] 异常处理完备性检查 + +## 🏷️ 任务标记说明 + +| 状态 | 标记 | 说明 | +|------|------|------| +| 未开始 | ⏳ | 任务还未开始执行 | +| 进行中 | 🔄 | 任务正在执行中 | +| 已完成 | ✅ | 任务已完成并通过检查 | +| 有问题 | ❌ | 任务执行遇到问题需要重做 | +| 需审查 | 👀 | 任务完成需要审查确认 | + +## 📊 完成度统计 + +### 第一阶段 (紧急问题修复) +- 总任务数:**20** +- 已完成:**0** ✅ +- 进行中:**0** 🔄 +- 未开始:**20** ⏳ +- **完成率:0%** + +### 整体项目进度 +- 总任务数:**60+** +- 已完成:**0** ✅ +- 进行中:**0** 🔄 +- 未开始:**60+** ⏳ +- **整体完成率:0%** + +## 🚨 关键路径任务 (必须优先完成) + +1. **系统架构图绘制** - 影响整体技术方案理解 +2. **数据库DDL完善** - 影响开发实施 +3. **接口参数详化** - 影响前后端对接 +4. **业务流程图** - 影响业务理解和实施 + +## 📝 任务执行标准 + +### 代码示例标准 +- 基于RuoYi-Vue-Pro框架最新版本 +- 代码可执行且符合框架规范 +- 包含完整的注释说明 +- 提供配置文件示例 + +### 图表绘制标准 +- 使用Mermaid语法绘制 +- 图表清晰易懂,层次分明 +- 包含必要的说明文字 +- 符合技术文档图表规范 + +### 文档质量标准 +- 内容准确无误 +- 结构清晰完整 +- 格式规范统一 +- 可读性强,便于理解和实施 \ No newline at end of file diff --git a/water_biz_design_plan.md b/water_biz_design_plan.md deleted file mode 100644 index 4ffbe83..0000000 --- a/water_biz_design_plan.md +++ /dev/null @@ -1,190 +0,0 @@ -# 福建水务营收系统概要设计文档编写计划 - -## 一、项目背景与概述 - -福建水务营收系统是基于RuoYi-Vue-Pro和yudao-ui-admin-vue3框架开发的一套现代化水务营收管理系统,旨在满足原有系统的所有功能需求,并通过技术升级提升系统的性能、安全性和用户体验。 - -## 二、系统设计总体规划 - -### 1. 设计依据 - -- 原系统《营收系统_详细设计说明书》 -- 原系统《营收系统_需求规格说明书》 -- 原系统《营收系统_用户操作手册》 -- RuoYi-Vue-Pro框架开发文档 -- yudao-ui-admin-vue3框架开发文档 - -### 2. 设计原则 - -- **继承性原则**:确保新系统覆盖原有系统的所有功能 -- **先进性原则**:采用当前主流技术架构和开发框架 -- **扩展性原则**:设计良好的扩展接口,支持未来功能扩展 -- **安全性原则**:符合国家相关安全规范,确保系统安全可靠 -- **易用性原则**:优化用户界面,提升用户体验 - -## 三、编写工作步骤与时间规划 - -### 第一阶段:需求分析(2周) - -1. **原系统功能梳理** - - 研读原系统文档,提取核心功能点 - - 整理功能清单与功能描述 - - 确认需保留的功能与新增功能 - -2. **业务流程梳理** - - 梳理现有业务流程 - - 设计优化后的业务流程图 - - 与业务部门确认流程优化点 - -### 第二阶段:系统架构设计(2周) - -1. **技术架构设计** - - 前端技术架构设计:基于yudao-ui-admin-vue3框架,使用Vue 3.x + TypeScript + Element Plus - - 后端技术架构设计:基于RuoYi-Vue-Pro框架,使用Spring Boot 3.x + MyBatis Plus + Spring Security - - 数据库架构设计:基于MySQL/MariaDB,配合MyBatis Plus实现高效数据访问 - - 集成方案设计:与支付系统、短信系统、工作流引擎等第三方服务集成 - -2. **系统功能模块划分** - - 基于RuoYi-Vue-Pro的模块化设计:yudao-module-xxx形式组织代码 - - 采用前后端分离架构,定义清晰的API接口 - - 复用框架基础功能,包括权限管理、租户管理、系统管理等 - -### 第三阶段:详细设计(3周) - -1. **系统功能模块详细设计** - - 用户管理模块 - - 水表管理模块 - - 抄表管理模块 - - 收费管理模块 - - 账务管理模块 - - 票据管理模块 - - 营业网点管理模块 - - 报表管理模块 - - 系统管理模块 - -2. **数据库设计** - - 实体关系图设计 - - 数据表结构设计 - - 数据字典编制 - -3. **接口设计** - - 内部模块接口设计 - - 外部系统接口设计 - - API文档编制 - -### 第四阶段:非功能性设计(1周) - -1. **性能设计** - - 并发处理设计 - - 数据库优化设计 - - 缓存策略设计 - -2. **安全设计** - - 用户认证与授权设计 - - 数据安全设计 - - 审计日志设计 - -3. **部署设计** - - 系统部署架构 - - 服务器配置要求 - - 备份恢复方案 - -### 第五阶段:文档整合与评审(2周) - -1. **文档整合** - - 汇总各模块设计文档 - - 统一文档格式与风格 - - 完善文档引用与附录 - -2. **文档评审** - - 内部技术评审 - - 与业务部门确认 - - 根据反馈修改文档 - -## 四、人员分工建议 - -对于多人协作编写文档,建议按照以下方式进行分工: - -### 1. 按模块分工 - -- **架构师**:负责系统总体架构设计、技术选型、非功能性设计 -- **业务分析师**:负责需求分析、业务流程梳理、功能规划 -- **前端设计师**:负责前端架构设计、UI/UX设计、前端模块设计 -- **后端开发负责人**:负责后端架构设计、核心模块设计、安全设计 -- **数据库设计师**:负责数据库设计、数据模型设计、性能优化设计 - -### 2. 按系统功能分工 - -- **基础模块组**:负责用户管理、权限管理、系统管理等基础功能设计 -- **业务核心组**:负责水表管理、抄表管理、收费管理等核心业务功能设计 -- **财务模块组**:负责账务管理、票据管理等财务相关功能设计 -- **报表分析组**:负责报表管理、数据分析等统计分析功能设计 -- **集成对接组**:负责与外部系统的接口设计、数据同步设计 - -## 五、文档规范与模板 - -### 1. 文档格式规范 - -- 使用Markdown格式编写 -- 章节层级不超过4级 -- 图表统一使用PlantUML或Mermaid格式 -- 术语表达保持一致性 - -### 2. 设计文档模板 - -每个功能模块的设计文档应包含以下内容: - -```markdown -# [模块名称]设计说明 - -## 1. 功能概述 -[简要描述该模块的主要功能和目标] - -## 2. 功能列表 -[列出该模块包含的所有功能点] - -## 3. 业务流程 -[使用流程图描述主要业务流程] - -## 4. 数据模型 -[描述该模块涉及的主要数据实体及关系] - -## 5. 接口设计 -[描述该模块提供的接口,包括参数、返回值等] - -## 6. 界面设计 -[提供界面原型或描述,说明界面交互逻辑] - -## 7. 安全考虑 -[描述该模块的安全控制措施] - -## 8. 特殊说明 -[其他需要说明的事项] -``` - -## 六、Cursor Rules配置 - -为了使用Cursor更高效地完成概要设计文档,建议配置以下规则: - -1. **文档结构检查**:确保文档结构符合预定义的模板 -2. **术语一致性检查**:确保整个文档中术语使用的一致性 -3. **图表格式化**:自动格式化PlantUML或Mermaid图表代码 -4. **引用链接检查**:确保文档内的交叉引用有效 -5. **中文标点规范**:确保使用规范的中文标点符号 - -## 七、协作工具与流程 - -1. **版本控制**:使用Git进行文档版本控制 -2. **协作平台**:使用GitLab/GitHub进行协作 -3. **评审工具**:使用MR/PR进行文档评审 -4. **任务管理**:使用项目管理工具(如JIRA)跟踪文档编写进度 - -## 八、成果交付物 - -最终交付物应包括: - -1. 系统概要设计说明书(主文档) -2. 各功能模块详细设计说明 -3. 数据库设计说明书 -4. 接口设计说明书 -5. 部署运维设计说明书 \ No newline at end of file diff --git a/water_biz_integrated_doc.md b/water_biz_integrated_doc.md deleted file mode 100644 index b11e20c..0000000 --- a/water_biz_integrated_doc.md +++ /dev/null @@ -1,324 +0,0 @@ -# 福建水务营收系统设计文档 - -## 前言 - -本文档为福建水务营收系统的概要设计文档,基于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 主题定制 \ No newline at end of file diff --git a/water_biz_summary.md b/water_biz_summary.md deleted file mode 100644 index 4b6db86..0000000 --- a/water_biz_summary.md +++ /dev/null @@ -1,308 +0,0 @@ -# 福建水务营收系统概要设计文档总结 - -## 一、文档构成 - -福建水务营收系统概要设计文档包含以下几个主要部分: - -1. **设计计划文档**:描述文档编写计划、分工和规范 -2. **系统架构设计**:描述系统总体架构和技术选型 -3. **模块功能设计**:描述各功能模块的详细设计 -4. **数据库设计**:描述数据库结构和优化策略 -5. **接口设计**:描述系统内部和外部接口设计 -6. **部署运维设计**:描述系统部署架构和运维方案 - -## 二、主要内容概述 - -### 1. 设计计划文档 - -设计计划文档明确了概要设计文档的编写计划、时间规划、人员分工和文档规范,为后续设计工作提供了指导框架。主要内容包括: - -- 项目背景与概述 -- 系统设计总体规划 -- 编写工作步骤与时间规划 -- 人员分工建议 -- 文档规范与模板 -- Cursor Rules配置 -- 协作工具与流程 -- 成果交付物 - -### 2. 系统架构设计 - -系统架构设计描述了福建水务营收系统的总体架构、技术框架和实现方案,为系统开发提供了技术指导。主要内容包括: - -- 系统架构概述 -- 总体架构设计 -- 系统分层设计 -- 核心模块设计 -- 数据库设计 -- 接口设计 -- 安全设计 -- 高可用设计 -- 扩展性设计 -- 部署架构 - -### 3. 模块功能设计 - -模块功能设计详细描述了系统各个功能模块的设计,包括功能需求、业务流程、实现方式等。主要内容包括: - -- 用户管理模块 -- 水表管理模块 -- 抄表管理模块 -- 收费管理模块 -- 账务管理模块 -- 票据管理模块 -- 营业网点管理模块 -- 报表管理模块 -- 系统管理模块 -- 集成接口模块 - -### 4. 数据库设计 - -数据库设计描述了系统的数据模型、表结构和数据库优化策略,为数据存储和管理提供了技术方案。主要内容包括: - -- 数据库设计概述 -- 数据库架构设计 -- 数据模型设计 -- 数据库表结构设计 -- 数据库优化设计 -- 数据库安全设计 -- 数据备份与恢复 -- 数据库监控与维护 - -### 5. 接口设计 - -接口设计描述了系统内部模块间的接口和与外部系统的集成接口,为系统集成提供了技术方案。主要内容包括: - -- 接口设计概述 -- 接口设计原则 -- 内部模块接口 -- 外部系统接口 -- 接口安全设计 -- 接口测试策略 -- 接口文档管理 - -### 6. 部署运维设计 - -部署运维设计描述了系统的部署架构、运维方案和灾备策略,为系统运行维护提供了技术支持。主要内容包括: - -- 部署架构设计 -- 软件部署方案 -- 容器化部署方案 -- 系统运维方案 -- 持续集成与部署 -- 灾备方案 -- 运维工具链 -- 运维管理规范 - -## 三、编写建议 - -### 1. 编写前的准备 - -- **充分理解原系统**:详细阅读原有系统的需求和设计文档,理解系统功能和业务流程 -- **熟悉技术框架**:深入了解RuoYi-Vue-Pro和yudao-ui-admin-vue3框架的功能和架构 - - 学习RuoYi-Vue-Pro的核心模块结构与扩展机制 - - 掌握基于MyBatis Plus的数据访问层设计 - - 理解Spring Security的认证授权体系 - - 熟悉多租户的实现原理 - - 学习Vue 3和Element Plus组件库的使用 - - 了解前端路由和状态管理机制 -- **明确编写范围**:根据项目实际需求,确定概要设计文档的详细程度和范围 -- **收集参考资料**:收集相关技术资料、业界最佳实践和类似系统的设计文档作为参考 - -### 2. 编写过程中的注意事项 - -- **保持一致性**:确保文档风格、术语使用和格式保持一致 -- **关注重点**:重点描述系统架构、核心模块和关键技术方案 -- **图文结合**:使用图表辅助说明,提高文档可读性 -- **适当详细**:在关键部分提供足够详细的说明,确保开发人员能够理解设计意图 -- **考虑全面**:除功能需求外,也要考虑非功能性需求,如性能、安全、可靠性等 -- **保持更新**:随着设计的深入,及时更新文档内容 - -### 3. 多人协作编写策略 - -- **明确分工**:按模块或专业领域划分编写任务,明确每人负责的部分 -- **统一模板**:使用统一的文档模板和编写规范 -- **定期评审**:定期组织文档评审会议,确保文档质量和一致性 -- **版本控制**:使用Git等工具进行文档版本控制,跟踪文档变更 -- **集中整合**:指定专人负责整合各部分文档,确保文档的完整性和一致性 - -### 4. 编写工具使用建议 - -- **使用Markdown**:采用Markdown格式编写文档,便于版本控制和协作 -- **使用Cursor**:利用Cursor的智能提示和规则检查功能,提高编写效率 -- **使用PlantUML/Mermaid**:使用PlantUML或Mermaid绘制架构图、流程图等 -- **使用Git**:使用Git进行文档版本控制和协作管理 -- **使用自动化工具**:使用自动化工具检查文档格式、拼写和一致性 - -## 四、后续工作建议 - -### 1. 文档评审与完善 - -- 组织技术评审会议,邀请架构师、技术负责人和关键开发人员参与 -- 收集评审意见,针对性地修改和完善文档 -- 进行文档质量检查,确保文档的完整性、准确性和一致性 - -### 2. 详细设计与开发 - -- 基于概要设计文档,进行详细设计,包括具体的类设计、算法设计等 -- 按照设计文档指导开发工作,确保实现与设计保持一致 -- 在开发过程中,根据实际情况适当调整设计,并更新文档 - -### 3. 文档维护与更新 - -- 建立文档变更管理机制,记录文档变更历史 -- 根据系统演进情况,定期更新设计文档 -- 将设计文档与代码库关联,确保文档与代码的一致性 - -## 五、常见问题与解决方案 - -### 1. 文档过于庞大,难以管理 - -- 采用模块化的文档结构,将文档分为多个独立的部分 -- 建立文档索引,便于查找和导航 -- 使用自动化工具生成目录和交叉引用 - -### 2. 文档与实际实现不一致 - -- 建立设计与开发的反馈机制,及时发现并解决不一致问题 -- 在开发过程中,同步更新设计文档 -- 定期进行文档审核,确保与实际实现保持一致 - -### 3. 多人协作导致风格不一致 - -- 制定统一的文档编写规范和模板 -- 使用Cursor Rules自动检查文档风格和格式 -- 指定专人负责文档的最终审核和整合 - -### 4. 文档内容难以理解 - -- 增加图表和示例,提高文档可读性 -- 采用简洁明了的语言,避免晦涩难懂的技术术语 -- 对关键概念和术语提供清晰的定义和解释 - -# 福建水务业务系统概述 - -## 目录 -- [1. 系统背景](#1-系统背景) -- [2. 系统目标](#2-系统目标) -- [3. 系统范围](#3-系统范围) -- [4. 系统用户](#4-系统用户) -- [5. 系统特点](#5-系统特点) -- [6. 系统价值](#6-系统价值) - -## 1. 系统背景 - -福建水投集团注册资本46亿元,经营范围为水利项目投资及管理,水利工程建筑设计与施工及相关技术服务;水资源开发与利用,水的生产与供应、污水处理及其再生利用,水生态产业投资、运营及相关配套服务;水利设施周边配套土地等资源综合开发利用等。 - -在全省40多个县市区投资重大水利项目超过450亿元,实现全省全覆盖,大幅控制我省岛屿、沿海经济发达以及经济发展潜力大、后劲足的地区水资源、水务市场。目前,集团公司总资产超173亿元,净资产超70亿元,拥有全级次子公司超过67家,职工人数超3500人。 - -当前,福建水投集团针对营收、新装、表务等核心业务系统,在集团下属各水务公司中,在用的业务系统均来自不同的系统集成商,存在业务不统一、软件功能不完善、自动化数据处理水平低、升级维护工作量大、自建硬件环境导致运营成本过高等弊端,加上由于业务、数据过度分散,不利于集团化的集中管理、统一资源管理理念。 - -随着互联网技术的飞速发展,以及市场竞争日益激烈的今天,集中企业优势、发展企业已成社会共识。通过应用系统集中部署,可以在此基础上实现先进的集团化管理理念。目前集团已经搭建起私有云,需要在信息系统建设方面,统一构建SaaS模式服务平台,服务于集团、各分公司、营业网点,以便于实现集中式生产控制、集中式财务控制、集中物资管理、公司领导对下属各水务公司的集中管理和综合报表上报、分析的功能。 - -## 2. 系统目标 - -福建水务业务系统是以客户关系数据库为核心和基础的综合管理平台,包含客户完整的资料和数据,实现客户全生命周期管理。系统建设的主要目标包括: - -1. **统一资源服务**:在集团现有基础上,建设统一的数字水务系统运行资源环境,为集团下属各分公司提供日常业务的IT运营环境服务。 - -2. **统一平台应用**:根据业务需要,在集团所属分公司在用的营收、新装、表务系统基础上进行全面改造升级,统一业务,集中汇集数据,形成统一、多租户管理模式的营业收费系统。集团所属各分公司不再独立建设业务系统基础设施和开发应用系统,实现"一个业务平台、一网通平台"的建设目标。 - -3. **统一业务平台功能**:建设平台具备集团、分公司、分公司所属业务站点多租户管理模式,实现对用水客户的营收业务、新装业务、表务业务管理功能;各租户之间独立,数据统一汇总到集团数据中心。 - -4. **统一对外接口**:整合统一用户资源,与相关业务系统对接提供标准的接口和能力。 - -5. **统一对外服务**:统一对外服务标准,为百姓提供便民服务,做到从"群众跑路"到"数据跑腿"的转变,简化百姓办事流程、提高办事效率、提升百姓的获得感,塑造良好的企业形象。 - -通过系统的建设,实现福建省水投数字科技有限公司客户服务管理领域的业务流程梳理再造、组织架构的优化、管理制度的建设、绩效考核标准的建设。构建以客户为中心的客户服务平台,将客户的所有信息进行有机的关联,方便企业对客户信息进行综合分析和管理,为客户提供更多、更便捷、更主动的个性化服务,提高客户服务的质量和客户满意度。 - -## 3. 系统范围 - -福建水务业务系统的功能范围涵盖客户服务全生命周期,主要包括以下功能模块: - -1. **统一平台**:员工管理、权限管理、组织机构、系统菜单配置、角色配置、水表厂家、水表型号、水表量程等。 - -2. **营收系统**: - - 价格管理:调价、历史价格查询 - - 用户档案管理:客户信息、表卡信息、账户信息、联系人信息、更名过户、注销报停 - - 抄表开账:册本管理、新卡入册、册本调动、抄表录入、抄表数据审核、追加抄表 - - 收费管理:柜台收费、柜台结账、预付款管理、凭证收费、结账记录查询、缴费记录查询 - - 账务处理:未销调整、违约金减免、特殊开账、账务退款、销账调正、预付款退款、违约金退款、待处理管理、账务处理日志查询 - - 发票管理:库存管理、发票打印、发票查询、发票调整 - - 综合查询:用户综合查询、报表查询、欠费查询 - -3. **表务系统**: - - 表务工单:换表计划、换表工单、移表工单、拆表工单、复装工单、校表工单 - - 表务仓库:新表入库、水表领用、水表出库、水表退库、水表生命周期查询 - -4. **报装系统**: - - 报装立户:一户一表 - - 报装流程管理 - -5. **客户服务**: - - 微信、支付宝服务窗 - - 历史账单查询 - - 电子发票 - - 营业网点查询 - - 账户流水查询 - - 微网厅 - -6. **外部接口**: - - 银行接口 - - 支付宝/微信接口 - - 短信接口 - - 系统对外查询接口 - -## 4. 系统用户 - -福建水务业务系统的用户主要包括以下几类: - -1. **集团管理人员**:负责对全集团业务数据进行统计分析、监督管理。 - -2. **分公司管理人员**:负责分公司业务管理、数据统计分析。 - -3. **营业网点工作人员**:负责日常营业收费、客户服务等工作。 - -4. **抄表员**:负责水表抄读、录入等工作。 - -5. **表务人员**:负责水表安装、更换、维修等工作。 - -6. **报装人员**:负责新用户报装、立户等工作。 - -7. **系统管理员**:负责系统参数配置、用户权限管理等工作。 - -8. **最终用户**:通过微信、支付宝服务窗、微网厅等渠道使用系统服务的水务客户。 - -## 5. 系统特点 - -福建水务业务系统具有以下特点: - -1. **多租户架构**:支持集团、分公司、营业站点多层级租户管理模式,各租户数据相互隔离,同时数据可统一汇总到集团数据中心。 - -2. **一体化设计**:将营收、表务、报装等业务系统集成为一体,实现业务流程的无缝衔接。 - -3. **全渠道服务**:支持营业厅柜台、自助终端、移动APP、微信小程序、支付宝服务窗等多种服务渠道。 - -4. **智能化应用**:引入智能抄表、智能分析等功能,提高业务处理效率和准确性。 - -5. **标准化接口**:提供标准化的接口,支持与银行、支付平台、短信平台等外部系统的集成。 - -6. **安全可靠**:系统满足安全等保三级要求,确保系统和数据的安全性。 - -7. **高性能扩展**:系统支持100万客户规模,满足企业未来3-5年的业务发展需求。 - -## 6. 系统价值 - -福建水务业务系统的建设将为企业带来以下价值: - -1. **降低IT成本**:通过统一平台建设,减少重复投资,降低硬件采购、系统运维等成本。 - -2. **提高管理效率**:实现业务流程优化再造,提高业务处理效率,降低人力成本。 - -3. **增强数据价值**:实现数据的集中管理和统一分析,为管理决策提供有力支持。 - -4. **提升服务质量**:为客户提供便捷、多渠道的服务方式,提高客户满意度。 - -5. **支持业务创新**:为业务创新提供灵活的技术支持,增强企业市场竞争力。 - -6. **促进企业发展**:支持企业规模扩张,为福建水投集团打造成水利行业龙头企业提供信息化支撑。 \ No newline at end of file