fujian_water_biz_doc/docs/design/01_Project_Overview.md

6.9 KiB
Raw Blame History

福建水务营收系统项目概览

文档定位

本文档用于对福建水务营收系统项目形成统一、简明、可快速理解的总体概览,便于在方案讨论、资料整编、文档维护、评审沟通和新成员接手时快速建立整体认知。

本文档不替代正式的概要设计、详细设计、数据库设计和接口设计文档,而是作为这些正式文档的导航入口与摘要说明。

项目基本信息

项目项 内容
项目名称 福建水务营收系统
项目类型 水务行业营收业务管理与客户服务一体化信息系统
当前仓库属性 技术文档与设计资料仓库
当前工作重点 文档整编、结构优化、设计口径统一、历史资料归档与映射核对
主要目标 形成可评审、可交付、可持续维护的系统设计文档体系

项目背景

福建水务营收系统面向水务企业营收管理、客户服务、表务管理、报装业务、移动抄表及基础服务能力建设场景,目标是建立一套覆盖业务办理、费用管理、渠道服务、基础支撑与外部集成的一体化系统设计体系。

从当前仓库内容来看,本项目已经形成了较完整的设计资料基础,包括总体设计、详细设计、数据库设计、接口设计、安全设计、部署设计,以及需求说明、操作手册、历史设计稿、数据字典和后端表映射等辅助材料。当前工作的重点更偏向于:

  • 统一正式文档结构与表述口径
  • 对齐概要设计、详细设计与技术专项文档之间的内容边界
  • 基于归档资料核对业务功能、数据模型和接口范围
  • 降低历史版本并存带来的理解成本与维护成本

项目范围概览

结合现有主文档与历史资料,福建水务营收系统当前覆盖的范围主要包括以下几个方面:

1. 平台基础能力

  • 统一身份认证
  • 单点登录
  • 权限控制
  • 租户管理
  • 组织与参数管理
  • 审计与监控支撑

2. 核心营收业务

  • 客户资料管理
  • 抄表开账
  • 营业收费
  • 账务处理
  • 发票相关业务
  • 催缴管理
  • 统计分析
  • 代收业务
  • 业务参数配置

3. 客户服务与渠道服务

  • 账户绑定
  • 信息查询
  • 在线缴费
  • 电子发票服务
  • 营业网点服务
  • 业务办理服务
  • 柜面扫码支付
  • 微网厅服务能力

4. 独立业务子系统

  • 手机抄表 APP
  • 工单管理系统
  • 表务管理系统
  • 报装业务系统

5. 基础服务子系统

  • 发票服务子系统
  • 支付与银行结算子系统
  • 消息服务子系统

6. 外部集成范围

  • 银行代扣与结算接口
  • 第三方支付平台
  • 短信及通知渠道
  • 物联网/智能水表相关平台
  • CA / 电子签章能力
  • 其他政务或企业内部协同系统

当前仓库文档结构

仓库当前以“管理—总体—详细—技术—附录归档”的方式组织,结构清晰,适合长期维护:

00_Management/   项目管理、进度、交付标准、编写指南
01_High_Level/   系统概述、系统架构、概要设计、系统图谱
02_Detailed/     详细设计、模块设计、CA 安装设计
03_Technical/    数据库、表结构、接口、安全、部署、加密
04_Appendix/     附录与 Archive 历史资料
assets/          图片、模板等静态资源
docs/            辅助说明、研究资料、后端映射与专题文档
scripts/         导出、校验、处理脚本

当前正式主文档

建议优先围绕以下主文档开展维护,而不是继续创建平行版本:

类别 主文档 作用
总体概览 01_High_Level/01_System_Overview.md 系统背景、术语、参考资料等总览信息
概要设计 01_High_Level/03_Summary_Design.md 概要设计主稿
详细设计 02_Detailed/01_Detailed_Design.md 详细设计主稿
数据库设计 03_Technical/01_Database_Design.md 数据库设计主稿
接口设计 03_Technical/03_Interface_Design.md 接口设计主稿
安全设计 03_Technical/04_Security_Design.md 安全设计主稿
部署设计 03_Technical/05_Deployment_Design.md 部署设计主稿

Archive 与辅助资料的作用

04_Appendix/Archive/ 当前主要承载以下内容:

  • 需求规格说明书
  • 操作手册
  • 原始附件
  • 历史设计文档
  • 数据字典
  • 整合资料

这些资料的主要作用是:

  • 作为正式文档编写时的来源依据
  • 用于核对功能范围、术语、业务流程和数据对象
  • 用于对比历史版本差异
  • 为数据库设计、接口设计与后端实现映射提供线索

原则上Archive 应作为参考来源和归档容器使用,而不是直接替代正式主文档。

当前维护重点

根据仓库现状,当前更适合持续推进的工作包括:

  1. 统一主文档之间的系统名称、编号体系和术语口径
  2. 校正概要设计、详细设计、数据库设计、接口设计之间的不一致项
  3. 基于 docs/guides/BACKEND_CURRENT_STATUS.mddocs/guides/BACKEND_TABLE_MAPPING.md 对齐后端真实落地情况
  4. 继续清理历史文档迁移后遗留的路径、引用与图片关系问题
  5. docs/design/ 下逐步补充面向维护和沟通的设计导览文档

建议的 docs/design 子目录规划

如果后续你准备继续在 docs/design 下建设“设计导览层”,建议采用如下结构:

文件名 建议用途
01_Project_Overview.md 项目总览、范围、主文档导航
02_System_Landscape.md 子系统全景、边界与依赖关系
03_Document_Map.md 仓库文档地图、主稿与来源资料映射
04_Data_and_Interface_Map.md 数据与接口的主文档、来源资料、后端落地映射
05_Current_Gaps_and_TODO.md 当前缺口、待对齐事项、后续整编计划

阅读建议

如果是第一次接手本项目,建议按以下顺序阅读:

  1. 本文档:docs/design/01_Project_Overview.md
  2. 系统概述:01_High_Level/01_System_Overview.md
  3. 概要设计主稿:01_High_Level/03_Summary_Design.md
  4. 详细设计主稿:02_Detailed/01_Detailed_Design.md
  5. 数据库与接口主稿:03_Technical/01_Database_Design.md03_Technical/03_Interface_Design.md
  6. 后端现状与表映射:docs/guides/BACKEND_CURRENT_STATUS.mddocs/guides/BACKEND_TABLE_MAPPING.md
  7. Archive 中的需求、手册和数据字典资料

后续可继续扩展的方向

本文档初始化完成后,下一步可以继续补充:

  • 系统边界与子系统全景图
  • 文档主稿与来源资料对应关系图
  • 当前数据库设计与后端真实表映射摘要
  • 当前接口设计与外部系统依赖摘要
  • 待统一口径清单与整编路线图

如无特殊说明,docs/design/ 下的文档应以“导览、对齐、整编、摘要”为目标,避免重复复制正式主文档的大段正文。