tangweijie/fujian_water_biz_doc
1
0
Fork 0
Code Issues Pull Requests 12 Actions Packages Projects Releases 1 Wiki Activity
fujian_water_biz_doc/water_biz_summary.md

14 KiB
Raw Blame History

福建水务营收系统概要设计文档总结

一、文档构成

福建水务营收系统概要设计文档包含以下几个主要部分：

  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. 系统背景

福建水投集团注册资本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. 促进企业发展：支持企业规模扩张，为福建水投集团打造成水利行业龙头企业提供信息化支撑。