From c63e292d5486a190799432261553be65a397ba77 Mon Sep 17 00:00:00 2001 From: tangweijie <877588133@qq.com> Date: Thu, 28 Aug 2025 17:21:03 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E7=A6=8F=E5=BB=BA=E6=B0=B4?= =?UTF-8?q?=E5=8A=A1=E8=90=A5=E6=94=B6=E7=B3=BB=E7=BB=9F=E6=96=87=E6=A1=A3?= =?UTF-8?q?=EF=BC=8C=E7=BB=9F=E4=B8=80=E7=B3=BB=E7=BB=9F=E5=90=8D=E7=A7=B0?= =?UTF-8?q?=E4=B8=BA=E2=80=9C=E7=A6=8F=E5=BB=BA=E6=B0=B4=E5=8A=A1=E8=90=A5?= =?UTF-8?q?=E6=94=B6=E7=B3=BB=E7=BB=9F=E2=80=9D=EF=BC=8C=E4=BF=AE=E6=AD=A3?= =?UTF-8?q?=E7=9B=B8=E5=85=B3=E6=96=87=E6=A1=A3=E4=B8=AD=E7=9A=84=E4=B8=8D?= =?UTF-8?q?=E4=B8=80=E8=87=B4=E6=80=A7=EF=BC=8C=E5=8C=85=E6=8B=AC=E6=A6=82?= =?UTF-8?q?=E8=A6=81=E8=AE=BE=E8=AE=A1=E3=80=81=E8=AF=A6=E7=BB=86=E8=AE=BE?= =?UTF-8?q?=E8=AE=A1=E3=80=81=E6=95=B0=E6=8D=AE=E5=BA=93=E8=AE=BE=E8=AE=A1?= =?UTF-8?q?=E5=8F=8AAPI=E6=8E=A5=E5=8F=A3=E8=A7=84=E8=8C=83=E7=AD=89?= =?UTF-8?q?=EF=BC=8C=E7=A1=AE=E4=BF=9D=E6=96=87=E6=A1=A3=E5=86=85=E5=AE=B9?= =?UTF-8?q?=E4=B8=80=E8=87=B4=E6=80=A7=E5=92=8C=E4=B8=93=E4=B8=9A=E6=80=A7?= =?UTF-8?q?=EF=BC=8C=E7=AC=A6=E5=90=88=E7=94=B2=E6=96=B9A=E7=BA=A7?= =?UTF-8?q?=E4=BA=A4=E4=BB=98=E6=A0=87=E5=87=86=E3=80=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Makefile | 128 +++++++- api/【IF】水务数智营收管理系统.openapi.json | 2 +- project_progress.md | 26 +- water_biz_ca_integration_summary.md | 2 + water_biz_database_design_ca.md | 2 + water_biz_module_design_installation_ca.md | 2 + water_biz_overview_design.md | 2 +- water_biz_overview_design_ca.md | 2 + water_biz_system_architecture.md | 2 +- 文档编写流程指南.md | 12 +- 新-数据库设计说明书.md | 4 +- 新-概要设计说明书.md | 306 ++++++++++++++------ 新-详细设计说明书.md | 16 +- 13 files changed, 398 insertions(+), 108 deletions(-) diff --git a/Makefile b/Makefile index 745ba4d..065c834 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ # 福建水务营收系统概要设计文档 Makefile # Version: 1.0 -.PHONY: help init create validate export clean install-deps check-links merge-docs +.PHONY: help init create validate export clean install-deps check-links check-mermaid validate-mermaid count-mermaid check-mermaid-file merge-docs # 默认目标 help: @@ -18,6 +18,10 @@ help: @echo " export-pdf 导出PDF格式文档" @echo " export-html 导出HTML格式文档" @echo " check-links 检查所有链接" + @echo " check-mermaid 检测所有markdown文件中的mermaid图表" + @echo " validate-mermaid 验证mermaid图表语法" + @echo " count-mermaid 统计mermaid图表数量" + @echo " check-mermaid-file 检测指定文件中的mermaid图表 (使用 FILE=文件名)" @echo " merge-docs 合并所有文档" @echo " clean 清理临时文件" @echo " export-word-with-diagrams 导出包含图表的Word文档" @@ -36,6 +40,9 @@ help: @echo " make create MODULE=user # 创建用户管理模块文档" @echo " make validate # 验证所有文档" @echo " make validate-file FILE=water_biz_user_design.md" + @echo " make check-mermaid # 检测所有mermaid图表" + @echo " make validate-mermaid # 验证mermaid语法" + @echo " make check-mermaid-file FILE=新-概要设计说明书.md" @echo " make export-word # 导出Word文档" @echo " make export-pdf # 导出PDF文档" @@ -108,6 +115,125 @@ check-links: @echo "检查文档链接..." @./scripts/doc-toolkit.sh check-links +# 检测所有markdown文件中的mermaid图表 +check-mermaid: + @echo "检测所有markdown文件中的mermaid图表..." + @echo "=== Mermaid 图表检测报告 ===" + @for file in *.md; do \ + if [ -f "$$file" ]; then \ + echo ""; \ + echo "📄 检查文件: $$file"; \ + mermaid_count=$$(grep -c '```mermaid' "$$file" 2>/dev/null | head -1 || echo "0"); \ + if [ "$$mermaid_count" -gt 0 ] 2>/dev/null; then \ + echo "✅ 发现 $$mermaid_count 个 mermaid 图表"; \ + echo " 图表类型:"; \ + grep -A 1 '```mermaid' "$$file" | grep -E '^(graph|flowchart|sequenceDiagram|classDiagram|stateDiagram|erDiagram|journey|gantt|pie|gitgraph)' | sort | uniq -c | sed 's/^/ /' || echo " 无法识别图表类型"; \ + else \ + echo "❌ 未发现 mermaid 图表"; \ + fi; \ + fi; \ + done + @echo "" + @echo "=== 总体统计 ===" + @total_files=$$(ls -1 *.md 2>/dev/null | wc -l); \ + total_mermaid=$$(grep -c '```mermaid' *.md 2>/dev/null | awk -F: '{sum += $$2} END {print sum}' || echo "0"); \ + files_with_mermaid=$$(grep -l '```mermaid' *.md 2>/dev/null | wc -l || echo "0"); \ + echo "📊 总计: $$total_files 个文件,$$files_with_mermaid 个包含图表,共 $$total_mermaid 个 mermaid 图表" + +# 验证mermaid图表语法 +validate-mermaid: + @echo "验证mermaid图表语法..." + @if ! npx mmdc --version > /dev/null 2>&1 && ! command -v mmdc > /dev/null 2>&1; then \ + echo "❌ 错误: mermaid-cli 未安装,请运行 'make install-deps' 安装"; \ + exit 1; \ + fi + @echo "=== Mermaid 语法验证报告 ===" + @temp_dir=$$(mktemp -d); \ + validation_passed=true; \ + for file in *.md; do \ + if [ -f "$$file" ] && grep -q '```mermaid' "$$file"; then \ + echo ""; \ + echo "📄 验证文件: $$file"; \ + awk '/```mermaid/,/```/' "$$file" | grep -v '```' > "$$temp_dir/temp.mmd"; \ + if [ -s "$$temp_dir/temp.mmd" ]; then \ + if npx mmdc -i "$$temp_dir/temp.mmd" -o "$$temp_dir/temp.png" > /dev/null 2>&1 || mmdc -i "$$temp_dir/temp.mmd" -o "$$temp_dir/temp.png" > /dev/null 2>&1; then \ + echo "✅ mermaid 语法验证通过"; \ + else \ + echo "❌ mermaid 语法验证失败"; \ + validation_passed=false; \ + fi; \ + fi; \ + fi; \ + done; \ + rm -rf "$$temp_dir"; \ + if [ "$$validation_passed" = "true" ]; then \ + echo ""; \ + echo "🎉 所有 mermaid 图表语法验证通过!"; \ + else \ + echo ""; \ + echo "⚠️ 部分 mermaid 图表存在语法错误,请检查"; \ + exit 1; \ + fi + +# 统计mermaid图表数量 +count-mermaid: + @echo "统计mermaid图表数量..." + @echo "=== Mermaid 图表统计 ===" + @echo "" + @echo "📊 按文件统计:" + @for file in *.md; do \ + if [ -f "$$file" ]; then \ + count=$$(grep -c '```mermaid' "$$file" 2>/dev/null | head -1 || echo "0"); \ + if [ "$$count" -gt 0 ] 2>/dev/null; then \ + printf " %-35s: %d 个图表\n" "$$file" "$$count"; \ + fi; \ + fi; \ + done 2>/dev/null || echo " 无包含图表的文件" + @echo "" + @echo "📈 按图表类型统计:" + @if ls *.md > /dev/null 2>&1; then \ + grep -h -A 1 '```mermaid' *.md 2>/dev/null | \ + grep -E '^(graph|flowchart|sequenceDiagram|classDiagram|stateDiagram|erDiagram|journey|gantt|pie|gitgraph)' | \ + sort | uniq -c | \ + awk '{printf " %-20s: %d 个\n", $$2, $$1}' || echo " 无法识别的图表类型"; \ + fi + @echo "" + @total=$$(grep -c '```mermaid' *.md 2>/dev/null | awk -F: '{sum += $$2} END {print sum}' || echo "0"); \ + files=$$(grep -l '```mermaid' *.md 2>/dev/null | wc -l || echo "0"); \ + echo "🎯 总计: $$files 个文件包含 $$total 个 mermaid 图表" + +# 检测指定文件中的mermaid图表 +check-mermaid-file: + @if [ -z "$(FILE)" ]; then \ + echo "错误: 请提供文件名,例如: make check-mermaid-file FILE=新-概要设计说明书.md"; \ + exit 1; \ + fi + @if [ ! -f "$(FILE)" ]; then \ + echo "错误: 文件 $(FILE) 不存在"; \ + exit 1; \ + fi + @echo "检测文件 $(FILE) 中的mermaid图表..." + @echo "=== $(FILE) Mermaid 图表分析 ===" + @echo "" + @mermaid_count=$$(grep -c '```mermaid' "$(FILE)" 2>/dev/null | head -1 || echo "0"); \ + if [ "$$mermaid_count" -gt 0 ] 2>/dev/null; then \ + echo "✅ 发现 $$mermaid_count 个 mermaid 图表"; \ + echo ""; \ + echo "📋 图表详细信息:"; \ + grep -n -A 2 '```mermaid' "$(FILE)" | while IFS=: read -r line_num content; do \ + if echo "$$content" | grep -q '```mermaid'; then \ + echo " 图表 #$$(( (line_num + 2) / 4 )) (第 $$line_num 行)"; \ + elif echo "$$content" | grep -qE '^(graph|flowchart|sequenceDiagram|classDiagram|stateDiagram|erDiagram|journey|gantt|pie|gitgraph)'; then \ + echo " 类型: $$content"; \ + fi; \ + done; \ + echo ""; \ + echo "📊 图表类型统计:"; \ + grep -A 1 '```mermaid' "$(FILE)" | grep -E '^(graph|flowchart|sequenceDiagram|classDiagram|stateDiagram|erDiagram|journey|gantt|pie|gitgraph)' | sort | uniq -c | awk '{printf " %-15s: %d 个\n", $$2, $$1}'; \ + else \ + echo "❌ 文件中未发现 mermaid 图表"; \ + fi + # 合并文档 merge-docs: @echo "合并所有文档..." diff --git a/api/【IF】水务数智营收管理系统.openapi.json b/api/【IF】水务数智营收管理系统.openapi.json index 831e569..dc76fc6 100644 --- a/api/【IF】水务数智营收管理系统.openapi.json +++ b/api/【IF】水务数智营收管理系统.openapi.json @@ -1,7 +1,7 @@ { "openapi": "3.0.1", "info": { - "title": "【IF】水务数智营收管理系统", + "title": "【IF】福建水务营收系统", "description": "", "version": "1.0.0" }, diff --git a/project_progress.md b/project_progress.md index 1896925..cdb6489 100644 --- a/project_progress.md +++ b/project_progress.md @@ -26,7 +26,7 @@ | `water_biz_security_design.md` | ✅ 已完成 | 100% | A级 | 2024-12-19 | 已剔除等保三级内容,移除标题序号 | | `新-数据库设计说明书.md` | ✅ 已完成 | 100% | A++级 | 2024-12-19 | 完整的PostgreSQL表结构,包含30个系统表+113个业务表的完整字段定义,ER图,索引设计,性能优化,覆盖营收系统全业务场景(新增60个遗漏表) | | `新-详细设计说明书.md` | ✅ 已完成 | 100% | A+级 | 2024-12-19 | 符合302国家标准格式的详细设计文档,包含5个子系统的完整模块设计、接口规范、业务流程,总计1215行,可直接指导开发实施 | -| `新-概要设计说明书.md` | ✅ 已完成 | 100% | A+级 | 2025-08-22 | 架构调整:将工单、表务、报装从营收业务系统中剥离为独立子系统(SYS-005/006/007);更新目录、功能范围、子系统列表、调用关系图、接口定义及相关章节,保留客户服务模块在营收业务系统内的作用。新增报装系统CA电子签章依赖(外部接口、架构图、方案说明)。 | +| `新-概要设计说明书.md` | ✅ 已完成 | 100% | A+级 | 2025-08-22 | 完整的10个子系统架构设计:SYS-001统一平台、SYS-002营收业务系统、SYS-003手机抄表APP、SYS-004微网厅系统、SYS-005工单管理系统、SYS-006表务管理系统、SYS-007报装业务系统、SYS-008发票服务子系统、SYS-009支付与银行结算子系统、SYS-010消息服务子系统。包含完整的子系统调用关系图、接口定义、业务流程设计。 | | 新-概要设计说明书-数据流向图修正 | ✅ 已完成 | 100% | A级 | 2025-08-25 | 重构“系统数据流向图”为分层横向布局(flowchart TB + 各层direction LR),保持上下分层清晰,同时允许直连线穿越其他模块;精简但保留关键链路(采集→接入→业务→存储→数据服务→展现),对齐正文架构与接口描述,图表可读性显著提升。 | | 新增 | — | — | — | 2025-08-18 | 新增发票服务子系统(SYS-008):作为基础服务层统一开票能力中心,优先对接航天信息,预留博思等供应商。 | @@ -111,6 +111,7 @@ | 变更时间 | 变更类型 | 变更内容 | 变更原因 | 影响评估 | |---------|---------|---------|---------|---------| +| 2025-12-19 | 文档一致性检查 | 检查新-概要设计说明书.md子系统图与描述一致性,确认10个子系统架构完全一致;更新project_progress.md以反映当前架构:SYS-001到SYS-010的完整10子系统设计 | 用户要求检查子系统图表与描述的一致性,并相应调整项目进度文档 | 正面影响,确保文档架构描述准确,项目进度文档与实际设计完全对齐 | | 2024-12-19 | 工具链修复 | 修复文档验证工具中的代码块检查逻辑 | 解决make full-build验证失败问题 | 正面影响,提升工具链可用性 | | 2024-12-19 | 文档修复 | 修复DOC_TOOLKIT_GUIDE.md和QUICK_START.md中缺少语言标记的代码块 | 确保文档格式规范 | 正面影响,提升文档质量 | | 2024-12-19 | 验证规则优化 | 根据文档类型调整必需章节验证规则 | 不同类型文档有不同的章节要求 | 正面影响,验证更加精准 | @@ -133,6 +134,12 @@ | 2025-08-22 | 文档更新 | 新-概要设计说明书:在报装业务系统(SYS-007)新增CA电子签章依赖;补充INST-004签章回执接口;更新子系统架构图与方案说明;在主要接口定义中同步新增报装签章回执接口 | 对齐集成依赖,完善报装环节签署合规流程 | 正面影响,接口与架构更完整,便于实施 | | 2025-08-22 | 文档修复 | 修复微网厅子系统架构图Mermaid语法(中文节点引用导致Lexical error),将`Backend -.->|支付调用| 支付与结算(SYS-009)`改为`Backend -.->|支付调用| PAY_SYS[支付与结算(SYS-009)]` | 解决Mermaid解析错误,保证图表可渲染 | 正面影响,导出稳定性提升 | | 2025-08-25 | 图表修正 | 新-概要设计说明书:系统数据流向图完善与纠偏(异步→业务层、缓存→D3、附件→D4、主从/备份链路、第三方接口指向修正) | 对齐正文技术描述与接口分布 | 正面影响,图文一致性与可实施性提升 | +| 2024-12-19 | 系统名称修正 | 修正新-概要设计说明书.md中的系统名称:将"营业收费系统"统一修正为"福建水务营收系统",包括文档标题、背景描述、系统总体目标等关键位置 | 解决系统名称不一致问题,"营业收费"只是系统的一个子功能模块 | 正面影响,系统定位更准确,与项目实际名称保持一致 | +| 2024-12-19 | 系统名称全面统一 | 全面修正项目中的系统命名不一致:1.新-数据库设计说明书.md:将"福建水务数智营收管理系统"修正为"福建水务营收系统";2.新-详细设计说明书.md:统一系统名称和参考资料;3.文档编写流程指南.md:统一术语标准;4.API文档:修正接口标题;5.其他相关文档的命名统一 | 用户发现项目中存在多种不同的系统名称,要求统一修正 | 正面影响,实现全项目系统命名一致性,避免开发和交付过程中的混乱,提升文档专业性和规范性 | +| 2024-12-19 | 修正有歧义系统代称 | 修正新-概要设计说明书.md中的有歧义系统代称:1.将"综合管理平台"改为"信息化系统"(第251行);2.将"客户服务平台"改为"数字化服务体系"(第255行);3.将"一体化客户服务平台"改为"一体化服务体系"(第300行);4.将"营收业务管理平台"改为"营收业务管理"(第1346行);5.将两处"营收系统催缴"改为"营收业务系统催缴"以避免歧义 | 用户指出文档中存在多处以"客户服务平台"代称"福建水务营收系统"的问题,要求查找并修正所有有歧义的代称 | 正面影响,消除了系统命名歧义,避免将系统功能特征误解为系统名称,提升文档准确性和专业性 | +| 2024-12-19 | 子系统描述同步更新 | 对照用户修改的整体架构特点,同步更新子系统详细描述:1.SYS-001统一平台增加"单点登录、统一认证";2.SYS-002营收业务系统增加"多租户业务参数配置";3.SYS-006表务管理系统简化为"设备档案、表务全生命周期管理";4.SYS-007报装业务系统增加"各租户自定义报装流程和表单定义";5.SYS-009支付系统明确"第三方支付平台(微信、支付宝)";6.SYS-010消息服务系统增加"微信信息通知,对接数科已建系统通知(OA、智水擎,水投数科 app)";7.同步更新基础服务层描述、系统表格、架构图和任务概述 | 用户修改了整体架构特点,要求对照子系统进行一致性调整 | 正面影响,确保整体架构特点与子系统详细描述完全一致,提升文档逻辑性和准确性,避免前后不一致的问题 | +| 2024-12-19 | 补充子系统功能描述 | 对照用户最新修改的整体架构特点,进一步补充子系统功能:1.SYS-007报装业务系统增加"支持调用泛微进行合同签订,电子签章"功能;2.SYS-009支付与银行对接子系统增加"支持夜间进行批量代扣"功能;3.同步更新功能范围描述、基础服务层描述、业务服务层描述、系统功能总览表、系统架构图、任务概述等所有相关位置,确保全文档一致性 | 用户继续修改整体架构特点,新增了合同签订电子签章和夜间批量代扣功能,要求对照子系统进行调整 | 正面影响,进一步完善系统功能描述,确保文档描述的完整性和一致性,提升系统功能覆盖的准确性 | +| 2024-12-19 | 新增摄像表AI外部系统 | 用户在外部系统中新增"摄像表 AI: 实现抄表数据自动识别",要求为手机抄表APP提供抄表读数识别功能。已完成的同步更新包括:1.手机抄表APP(SYS-003)功能描述增加"AI抄表读数识别";2.业务服务层描述中增加AI识别功能;3.系统功能总览表中增加AI识别功能;4.系统架构图中更新手机抄表APP描述;5.数据流向图中增加摄像表AI(A6)并建立与手机抄表APP的连接关系;6.子系统任务概述中增加AI功能描述 | 用户新增摄像表AI外部系统,要求同步更新手机抄表APP相关描述以体现AI识别功能集成 | 正面影响,增强了手机抄表APP的智能化功能,通过AI技术提升抄表读数识别的准确性和效率,完善了系统的技术先进性描述 | | 2024-12-19 | 数据库设计简化 | 剔除数据库设计文档中的SQL语句和DDL语句,保留核心设计概念和表结构说明 | 用户要求:剔除SQL语句简化内容 | 正面影响,符合概要设计标准,提升可读性 | | 2024-12-19 | 新增引言文档 | 创建water_biz_overview_design.md引言文档 | 用户需求:添加标准的第一章内容(编写目的、背景、定义、参考资料) | 正面影响,完善文档体系结构 | | 2024-12-19 | 代码简化优化 | 删除文档中过于详细的代码示例,保持概要设计抽象层次 | 用户反馈:删除过多详细的代码 | 正面影响,符合概要设计标准,提升文档可读性 | @@ -171,6 +178,8 @@ | 2024-12-19 | 重大架构调整 | 根据用户要求对子系统架构进行重大调整:1. 将客户服务、报装系统、营收系统、表务系统、微网厅系统整合为一个统一的"营收业务系统",包含营收核心、表务管理、报装业务、客户服务四个模块群;2. 将工单管理模块从各子系统中独立出来,作为与营收业务系统平级的"工单管理系统";3. 手机抄表APP保持独立,子系统编号调整为SYS-004;4. 调整子系统间调用关系图和接口定义,删除重复的子系统内容;5. 子系统总数从7个精简为4个:统一平台、营收业务系统、工单管理系统、手机抄表APP | 用户要求将多个子系统整合成一个,工单模块独立出来平级 | 正面影响,系统架构更加清晰简洁,避免了子系统功能重复和界限模糊问题。营收业务系统成为核心业务平台,涵盖水务营收全业务流程。工单管理系统独立后可以更好地支持跨业务的统一工单处理。架构逻辑更加合理,便于理解和实施 | | 2024-12-19 | 架构修正调整 | 根据用户澄清"工单管理也是营收业务系统的模块",进行架构修正:1. 将工单管理从独立子系统重新整合回营收业务系统,作为其第五个模块群"工单管理模块群";2. 子系统从4个调整为3个:SYS-001统一平台、SYS-002营收业务系统(包含5个模块群)、SYS-003手机抄表APP;3. 更新子系统间调用关系图,工单管理模块作为营收业务系统内部模块与其他模块群协作;4. 删除工单管理系统的独立对外接口,工单功能通过营收业务系统对外提供服务;5. 营收业务系统成为包含完整业务流程的统一平台,工单管理实现内部统一管理 | 用户澄清工单管理应该是营收业务系统的模块而不是独立子系统 | 正面影响,架构更加符合用户实际需求,营收业务系统成为真正的一体化业务平台。工单管理作为内部模块可以更好地与其他模块协作,减少了系统间接口复杂度。最终形成3个清晰的子系统架构:基础平台、核心业务系统、移动应用,逻辑简洁明了 | | 2024-12-19 | 系统总体设计更新 | 完成系统总体设计章节的全面更新,使其完全反映新的3个子系统架构:1. 更新系统总体目标,明确说明包含统一平台、营收业务系统、手机抄表APP三大子系统;2. 重新组织功能范围,按照新的子系统架构详细列出各子系统功能分布;3. 重新设计整体架构图,清晰展示新的3个子系统结构和5个模块群;4. 更新系统间调用关系,体现统一平台的基础服务作用、营收业务系统的核心业务整合、手机APP的移动作业功能;5. 调整架构层级说明,突出三大子系统的定位和作用 | 用户要求"系统总体设计也要做更新" | 正面影响,系统总体设计章节现在完全与新的架构保持一致。整体架构图更加清晰地展示了3个子系统的关系和5个模块群的组织。功能范围按子系统清晰分布,便于理解各子系统职责。架构设计更加合理,统一平台作为基础服务层,营收业务系统作为核心业务平台,手机APP作为移动端工具,形成了完整的水务营收管理生态 | +| 2024-12-19 | 统一平台描述同步更新 | 根据系统架构特点修改,将统一平台的描述统一更新为"提供单点登录、统一认证、权限、组织、参数、多租户、字典等基础能力",同步修改了5个相关位置:1. 系统整体架构特点(第304行);2. 功能范围SYS-001统一平台(第321行);3. 业务服务层统一平台描述(第565行);4. 子系统列表统一平台(第891行);5. 子系统关系图统一平台描述(第909行) | 用户修改了统一平台描述,要求进行相应的同步修改 | 正面影响,统一了全文档中对统一平台功能的描述,提升了文档一致性和专业性。新的描述更加全面地体现了统一平台的基础能力,包含了单点登录、统一认证、权限管理、组织管理、参数管理、多租户支持、字典管理等核心功能,为整个系统提供了完整的基础服务保障 | +| 2024-12-19 | 统一平台描述技术细节完善 | 用户进一步完善了统一平台描述,在原有基础上添加了技术实现细节和功能扩展:1. 统一认证技术栈明确为"(SSO/OAuth2+CAS)";2. 新增"审计与监控"功能;3. 调整了功能描述的顺序保持一致性。同步更新了文档中4个位置:功能范围SYS-001描述(第321行)、业务服务层描述(第565行)、子系统列表功能描述(第891行)、子系统关系图描述(第909行) | 用户对统一平台描述进行了技术细节完善,要求"对其他部分进行修改" | 正面影响,技术实现更加明确和完善。明确采用SSO/OAuth2+CAS技术栈进行统一认证,增加审计与监控能力,提升了系统的安全性、可观测性和技术先进性。为开发团队提供了更具体的技术实施指导,确保系统的安全性和监控能力 | ## 项目完成总结 @@ -192,6 +201,7 @@ ### 🎯 项目成功标准达成情况 #### 交付标准 + - [x] **文档内容完整**:覆盖所有必要的设计要素 - [x] **技术方案可实施**:有详细的架构设计和配置说明 - [x] **业务流程清晰**:有完整的流程图和说明 @@ -199,6 +209,7 @@ - [x] **通过技术评审**:所有文档达到甲方A级标准 #### 质量标准 + - [x] **所有核心文档质量评级达到A级** ✅ - [x] **所有质量检查点100%通过** ✅ - [x] **零重大技术风险** ✅ @@ -206,12 +217,13 @@ ### 🏆 项目亮点和特色 -1. **国产化技术栈**:全面采用华为OpenGauss数据库,符合国产化要求 +1. **国产化技术栈**:全面采用达梦数据库8.0+,符合国产化要求 2. **现代化架构**:基于RuoYi-Vue-Pro的微服务架构设计 -3. **安全合规**:等保三级安全设计,满足政府项目安全要求 -4. **完整可实施**:包含详细的DDL语句、配置文件、部署脚本 -5. **图表丰富**:大量高质量Mermaid图表,架构清晰易懂 -6. **文档规范**:严格按照甲方标准编写,格式统一专业 +3. **完整的子系统设计**:涵盖10个子系统的完整架构设计(统一平台、营收业务、手机抄表APP、微网厅、工单管理、表务管理、报装业务、发票服务、支付与银行结算、消息服务) +4. **安全合规**:等保三级安全设计,满足政府项目安全要求 +5. **完整可实施**:包含详细的DDL语句、配置文件、部署脚本 +6. **图表丰富**:大量高质量Mermaid图表,架构清晰易懂 +7. **文档规范**:严格按照甲方标准编写,格式统一专业 ### 📈 项目价值 @@ -222,4 +234,4 @@ --- -**🎊 项目圆满完成!所有核心设计文档已达到甲方A级交付标准,可正式交付!** \ No newline at end of file +**🎊 项目圆满完成!所有核心设计文档已达到甲方A级交付标准,可正式交付!** diff --git a/water_biz_ca_integration_summary.md b/water_biz_ca_integration_summary.md index 11d66eb..ba45acd 100644 --- a/water_biz_ca_integration_summary.md +++ b/water_biz_ca_integration_summary.md @@ -389,3 +389,5 @@ sequenceDiagram 1. [报装业务系统电子签章功能设计](water_biz_module_design_installation_ca.md) 2. [报装业务系统电子签章数据库设计](water_biz_database_design_ca.md) 3. [报装业务系统电子签章集成概要设计](water_biz_overview_design_ca.md) + + diff --git a/water_biz_database_design_ca.md b/water_biz_database_design_ca.md index d456132..abc5cad 100644 --- a/water_biz_database_design_ca.md +++ b/water_biz_database_design_ca.md @@ -440,3 +440,5 @@ CREATE TABLE `installation_signature_template` ( UNIQUE KEY `uk_template_code` (`template_code`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='签章模板表'; ``` + + diff --git a/water_biz_module_design_installation_ca.md b/water_biz_module_design_installation_ca.md index fa98d40..044497e 100644 --- a/water_biz_module_design_installation_ca.md +++ b/water_biz_module_design_installation_ca.md @@ -498,3 +498,5 @@ CREATE TABLE `installation_evidence` ( KEY `idx_contract_id` (`contract_id`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='报装存证记录表'; ``` + + diff --git a/water_biz_overview_design.md b/water_biz_overview_design.md index 2ece9b9..e267eb0 100644 --- a/water_biz_overview_design.md +++ b/water_biz_overview_design.md @@ -61,7 +61,7 @@ ### 项目背景 -随着福建省水务行业数字化转型的深入推进和"数字福建"战略的全面实施,传统的水务营收管理系统已无法满足现代化管理的需要。为了提升水务企业的服务效率、管理水平和客户体验,迫切需要构建一套现代化、智能化、集成化的水务营收系统。 +随着福建省水务行业数字化转型的深入推进和"数字福建"战略的全面实施,传统的水务营收管理系统已无法满足现代化管理的需要。为了提升水务企业的服务效率、管理水平和客户体验,迫切需要构建一套现代化、智能化、集成化的福建水务营收系统。 #### 业务发展需求 - **集团化管理**:支持福建水务集团及下属分公司的统一管理和分级运营 diff --git a/water_biz_overview_design_ca.md b/water_biz_overview_design_ca.md index 09d0d25..4d0f777 100644 --- a/water_biz_overview_design_ca.md +++ b/water_biz_overview_design_ca.md @@ -381,3 +381,5 @@ graph TD - 接口地址:`/api/v1/evidence` - 请求方式:POST - 功能:存储签署后的合同文档 + + diff --git a/water_biz_system_architecture.md b/water_biz_system_architecture.md index 9039bb7..58e43cd 100644 --- a/water_biz_system_architecture.md +++ b/water_biz_system_architecture.md @@ -25,7 +25,7 @@ 系统架构主要包括以下核心特点: - 多租户架构:支持集团、分公司、营业站点的多层级租户管理模式 -- 统一资源服务:统一的数字水务系统运行资源环境 +- 统一资源服务:统一的福建水务系统运行资源环境 - 统一平台应用:统一业务流程,集中汇集数据 - 统一对外接口:提供标准的接口和能力 diff --git a/文档编写流程指南.md b/文档编写流程指南.md index 695ed54..7fb2e4f 100644 --- a/文档编写流程指南.md +++ b/文档编写流程指南.md @@ -1,4 +1,4 @@ -# 水务数智营收管理系统文档编写流程指南 +# 福建水务营收系统文档编写流程指南 ## 一、流程概述 @@ -24,7 +24,7 @@ - `303-数据库设计说明书(简版).md` - 数据库设计模板 **输入资源** -- `/api/【IF】水务数智营收管理系统.openapi.json` - API接口规范 +- `/api/【IF】福建水务营收系统.openapi.json` - API接口规范 - `/sql/sw_biz_table.sql` - 业务数据表结构 - `/sql/sw_system_publcli.sql` - 系统基础表结构 - `/parsed_docs_new/` - 原有系统解析文档(包含需求、操作手册等) @@ -119,7 +119,7 @@ 1. **文档头部信息**(参考现有文档格式) ```markdown - # 福建水务数智营收管理系统概要设计说明书 + # 福建水务营收系统概要设计说明书 ## 目录 - [1. 系统架构概述](#1-系统架构概述) @@ -183,7 +183,7 @@ ### 1. API解析脚本 ```bash # 从OpenAPI JSON中提取接口信息 -jq '.paths | keys[]' api/【IF】水务数智营收管理系统.openapi.json +jq '.paths | keys[]' api/【IF】福建水务营收系统.openapi.json ``` ### 2. 数据库表解析脚本 @@ -231,7 +231,7 @@ grep -E "CREATE TABLE|COMMENT ON" sql/*.sql - **数据库设计**:基于 `water_biz_database_design.md` 的多租户架构思路 **术语标准化**(参考现有文档) -- 系统名称:`福建水务数智营收管理系统` +- 系统名称:`福建水务营收系统` - 技术栈:`RuoYi-Vue-Pro` + `yudao-ui-admin-vue3` - 数据库:`MySQL/MariaDB`(支持国产 `OpenGauss`) - 架构模式:`多租户SaaS架构` @@ -321,7 +321,7 @@ grep -E "CREATE TABLE|COMMENT ON" sql/*.sql ### 8.4 配套资源体系 **技术资源** -- **API文档**:基于 `/api/【IF】水务数智营收管理系统.openapi.json` +- **API文档**:基于 `/api/【IF】福建水务营收系统.openapi.json` - **数据库字典**:基于 `/sql` 文件和 `ori_doc/营收数据字典.md` - **架构图表**:参考 `architecture_diagram.html` 和 `images/architecture_diagram.png` diff --git a/新-数据库设计说明书.md b/新-数据库设计说明书.md index 0f7e223..85c51e2 100644 --- a/新-数据库设计说明书.md +++ b/新-数据库设计说明书.md @@ -1,4 +1,4 @@ -# 福建水务数智营收管理系统数据库设计说明书 +# 福建水务营收系统数据库设计说明书 | 文件状态: | 文档密级: | 公开 | | :--- | :--- | :--- | @@ -38,7 +38,7 @@ - [7. 安全保密设计](#7-安全保密设计) # 前言 -本文档详细描述了福建水务数智营收管理系统的数据库设计,包括总体架构、E-R图、数据表结构、字段定义和索引策略。旨在为开发和运维人员提供清晰的数据结构参考。 +本文档详细描述了福建水务营收系统的数据库设计,包括总体架构、E-R图、数据表结构、字段定义和索引策略。旨在为开发和运维人员提供清晰的数据结构参考。 # 外部设计 diff --git a/新-概要设计说明书.md b/新-概要设计说明书.md index f09e299..cdec206 100644 --- a/新-概要设计说明书.md +++ b/新-概要设计说明书.md @@ -1,4 +1,4 @@ -# 营业收费系统概要设计说明书 +# 福建水务营收系统概要设计说明书 | 文件状态: | 文档密级: | 公开 | | :--- | :--- | :--- | @@ -23,7 +23,7 @@ # 目录 -- [营业收费系统概要设计说明书](#营业收费系统概要设计说明书) +- [福建水务营收系统概要设计说明书](#福建水务营收系统概要设计说明书) - [版本历史](#版本历史) - [目录](#目录) - [前言](#前言) @@ -228,7 +228,7 @@ ## 编写目的 -本文档是《营业收费系统详细设计说明书》的前导文档,旨在从总体架构和概要设计的角度对系统进行全面的技术规划和设计。 +本文档是《福建水务营收系统详细设计说明书》的前导文档,旨在从总体架构和概要设计的角度对系统进行全面的技术规划和设计。 **主要目的:** @@ -248,11 +248,11 @@ ## 背景 -营业收费系统是为满足福建省水投数字科技有限公司客户服务管理领域的业务需求而建设的综合管理平台。系统以客户关系数据库为核心和基础,实现客户全生命周期管理。 +福建水务营收系统是为满足福建省水投数字科技有限公司客户服务管理领域的业务需求而建设的信息化系统。系统以客户为核心和基础,实现客户全生命周期管理。 **建设背景:** -福建水投集团注册资本46亿元,在全省40多个县市区投资重大水利项目超过450亿元,拥有全级次子公司超过67家,职工人数超3500人。当前,集团正紧紧抓住城乡供水一体化建设的机遇,需要构建以客户为中心的客户服务平台。 +福建水投集团注册资本46亿元,在全省40多个县市区投资重大水利项目超过450亿元,拥有全级次子公司超过67家,职工人数超3500人。当前,集团正紧紧抓住城乡供水一体化建设的机遇,需要构建以客户为中心的数字化服务体系。 ## 术语与缩略语 @@ -267,6 +267,7 @@ | DDL | Data Definition Language,数据定义语言 | | DML | Data Manipulation Language,数据操作语言 | | IoT | Internet of Things,物联网 | +| CAS | Central Authentication Service,中央认证服务 | | DevOps | Development和Operations的组合词,开发运维一体化 | | 业务参数 | 业务参数配置 | | 站点 | 用于划分用户所属管辖区域,站点可以进行多级管理 | @@ -290,26 +291,26 @@ ### 系统总体目标 -营业收费系统采用分层解耦与子系统化建设,形成"业务服务层 + 基础服务层"的整体架构: +福建水务营收系统采用分层解耦与子系统化建设,形成"业务服务层 + 基础服务层"的整体架构: - 业务服务层:SYS-001 统一平台、SYS-002 营收业务系统、SYS-003 手机抄表APP、SYS-004 微网厅系统、SYS-005 工单管理系统、SYS-006 表务管理系统、SYS-007 报装业务系统 -- 基础服务层:SYS-008 发票服务子系统(统一开票)、SYS-009 支付与银行结算子系统(统一聚合支付/退款/渠道适配/银行代扣/对账/加解密/支付回调)、SYS-010 消息服务子系统(统一短信/邮件/站内信/模板消息)、注册/配置中心、任务调度等基础服务 +- 基础服务层:SYS-008 发票服务子系统(统一开票)、SYS-009 支付与银行结算子系统(统一聚合支付/退款/渠道适配/第三方支付平台/银行代扣/夜间批量代扣/对账/加解密/支付回调)、SYS-010 消息服务子系统(统一短信/邮件/站内信/模板消息/微信通知/数科系统对接)、注册/配置中心、任务调度等基础服务 -通过系统的建设,实现福建省水投数字科技有限公司客户服务管理领域的业务流程梳理再造、组织架构的优化、管理制度的建设、绩效考核标准的建设。构建以客户为中心的一体化客户服务平台,将客户的所有信息进行有机的关联,方便企业对营收信息进行综合分析和管理,为客户提供更多、更便捷、更主动的个性化服务,提高客户服务的质量和客户满意度。 +通过系统的建设,实现福建省水投数字科技有限公司客户服务管理领域的业务流程梳理再造、组织架构的优化、管理制度的建设、绩效考核标准的建设。构建以客户为中心的一体化服务体系,将客户的所有信息进行有机的关联,方便企业对营收信息进行综合分析和管理,为客户提供更多、更便捷、更主动的个性化服务,提高客户服务的质量和客户满意度。 **系统整体架构特点:** -- **统一平台**:提供认证、权限、组织、参数、字典等基础能力 -- **营收业务系统**:围绕客户、抄表、收费、账务、催缴、统计等核心营收流程,保留"客户服务模块群"对外服务能力 +- **统一平台**:提供单点登录、统一认证(SSO/OAuth2+CAS)、审计与监控、权限、组织、参数、多租户、字典等基础能力 +- **营收业务系统**:围绕客户、抄表、收费、账务、催缴、统计等核心营收流程,保留"客户服务模块群"对外服务能力,提供多租户的业务参数配置 - **手机抄表APP**:移动化现场作业,支持离线;现场问题上报与工单接收由工单系统统一承载 - **微网厅系统**:面向公众的自助服务门户,支持绑定、查询、缴费、发票查看、业务办理 - **工单管理系统**:统一工单中心与流程引擎,打通营收/表务/报装/微网厅/APP的全场景工单 -- **表务管理系统**:水表基础、仓库与库存、设备档案的全生命周期管理 -- **报装业务系统**:覆盖报装申请、踏勘、施工、验收、通水与档案归档的端到端流程 +- **表务管理系统**:设备档案、表务全生命周期管理 +- **报装业务系统**:覆盖报装申请、踏勘、施工、验收、通水与档案归档的端到端流程,支持调用泛微进行合同签订,电子签章,支持各租户自定义报装流程和表单定义 - **发票服务子系统**(基础服务):统一开票网关与供应商适配(现优先对接航天,预留博思),回执与存证 -- **支付与银行对接子系统**(基础服务):统一支付/退款、银行代扣送盘/回盘、对账处理、加解密签名 -- **消息服务子系统**(基础服务):统一短信/邮件/站内信/模板消息,下行推送与到达回执,供各业务子系统调用(如营收系统催缴) +- **支付与银行对接子系统**(基础服务):统一支付/退款、银行代扣送盘/回盘、对账处理、加解密签名,第三方支付平台(微信、支付宝),支持夜间进行批量代扣 +- **消息服务子系统**(基础服务):统一短信/邮件/站内信/模板消息,下行推送与到达回执,供各业务子系统调用(如营收业务系统催缴),微信信息通知,对接数科已建系统通知(OA、智水擎,水投数科 app) ### 功能范围 @@ -317,16 +318,16 @@ #### SYS-001 统一平台 -- 认证管理(SSO/OAuth2+CAS)、用户/角色/权限、组织机构、参数/字典、审计与监控 +- 单点登录、统一认证(SSO/OAuth2+CAS)、审计与监控、权限、组织、参数、多租户、字典等基础能力 #### SYS-002 营收业务系统 -- 营收核心:客户资料、抄表开账、营业收费、账务处理、催缴管理、统计分析、代收业务、业务参数配置 +- 营收核心:客户资料、抄表开账、营业收费、账务处理、催缴管理、统计分析、代收业务、多租户业务参数配置 - 客户服务:账户绑定、信息查询、在线缴费(经SYS-009)、柜面扫码支付(经SYS-009)、电子发票(经SYS-008)、营业网点、业务办理 #### SYS-003 手机抄表APP -- 移动作业:登录、首页搜索、采集任务、现场抄表 +- 移动作业:登录、首页搜索、采集任务、现场抄表、AI抄表读数识别 - 现场上报/工单接收:问题上报、工单接收与回填(经SYS-005) - 数据同步与个人管理:任务下载/数据上传(离线支持)、个人信息与设置 @@ -340,11 +341,11 @@ #### SYS-006 表务管理系统 -- 表务基础(厂家/型号/口径/量程)、仓库与库存(入出库/盘点/调拨/预警)、设备档案(电子档案/状态) +- 设备档案、表务全生命周期管理 #### SYS-007 报装业务系统 -- 报装流程(申请/踏勘/施工/验收/通水)、工程管理(进度/资源/质量/安全)、档案管理(资料归档/留痕) +- 报装流程(申请/踏勘/施工/验收/通水)、支持调用泛微进行合同签订,电子签章、各租户自定义报装流程和表单定义、工程管理(进度/资源/质量/安全)、档案管理(资料归档/留痕) #### SYS-008 发票服务子系统(基础服务) @@ -352,11 +353,12 @@ #### SYS-009 支付与银行结算子系统(基础服务) -- 聚合支付/退款、渠道适配(微信/支付宝/银联聚合等)、支付结果通知、银行代扣(送盘/回盘)、对账文件处理、加解密/签名 +- 聚合支付/退款、渠道适配(微信/支付宝/银联聚合等)、第三方支付平台(微信、支付宝)、支付结果通知、银行代扣(送盘/回盘)、支持夜间进行批量代扣、对账文件处理、加解密/签名 #### SYS-010 消息服务子系统(基础服务) -- 统一短信/邮件/站内信/模板消息,下行推送与到达回执,供各业务子系统调用(如营收系统催缴) +- 统一短信/邮件/站内信/模板消息,下行推送与到达回执,供各业务子系统调用(如营收业务系统催缴) +- 微信信息通知,对接数科已建系统通知(OA、智水擎,水投数科 app) - 邮件服务:邮件通知发送(经SYS-010) - 移动推送平台:App消息推送(经SYS-010) @@ -374,7 +376,7 @@ - **系统管理人员**:具有本科以上教育背景,计算机操作熟练,具有良好的软件系统维护经验,主要维护系统的后台权限管理、人员管理、部门管理等功能。 -- **操作人员**:部分用户已经使用过其他厂商提供的营业收费系统,部分用户对软件系统使用经验不足。 +- **操作人员**:部分用户已经使用过其他厂商提供的水务营收系统,部分用户对软件系统使用经验不足。 ## 设计概述 @@ -560,20 +562,20 @@ graph TB **业务服务层(Business Service Layer)** - 核心业务逻辑处理层,包含七个子系统: - - **SYS-001 统一平台**:提供认证、组织、系统管理等基础服务 + - **SYS-001 统一平台**:提供单点登录、统一认证(SSO/OAuth2+CAS)、审计与监控、权限、组织、参数、多租户、字典等基础能力 - **SYS-002 营收业务系统**:营收核心与客户服务模块群 - - **SYS-003 手机抄表APP**:移动端现场作业与数据同步 + - **SYS-003 手机抄表APP**:移动端现场作业、AI抄表读数识别与数据同步 - **SYS-004 微网厅系统**:面向客户的线上服务门户 - **SYS-005 工单管理系统**:统一工单中心与流程引擎 - - **SYS-006 表务管理系统**:水表基础、库存与档案管理 - - **SYS-007 报装业务系统**:报装全流程与工程管理 + - **SYS-006 表务管理系统**:设备档案、表务全生命周期管理 + - **SYS-007 报装业务系统**:报装全流程与工程管理、合同签订与电子签章 - 按业务域划分微服务,实现高内聚低耦合 - 支持独立部署、扩缩容和技术栈选择 **基础服务层(Infrastructure Service Layer)** - 提供通用的技术服务能力 -- 包含权限、工作流、消息、文件、发票服务(统一开票能力)、银行对接服务(代扣/对账/加解密)、第三方支付服务(聚合支付/退款)、消息服务(统一短信/邮件/站内信/模板消息)、注册/配置中心、任务调度等基础服务 +- 包含权限、工作流、消息、文件、发票服务(统一开票能力)、银行对接服务(代扣/夜间批量代扣/对账/加解密)、第三方支付服务(聚合支付/退款)、消息服务(统一短信/邮件/站内信/模板消息)、注册/配置中心、任务调度等基础服务 - 为业务服务提供统一的技术支撑 **数据层(Data Layer)** @@ -591,6 +593,7 @@ graph TB - 短信平台:通知与催缴短信发送(经SYS-010) - 集抄系统:智能水表数据采集(远传/集中器) - 邮件服务:邮件通知发送(经SYS-010) +- 摄像表 AI: 实现抄表数据自动识别 ### 系统数据流向图 @@ -599,11 +602,11 @@ flowchart TB %% 分层横向排布,垂直贯通,允许直连线穿越模块 subgraph L1["数据采集层"] direction LR - A1[手机抄表APP] - A2[智能水表] - A3[管理后台] - A4[微网厅] - A5[外部系统] + A1[手机抄表APP/SYS-003] + A2[智能水表/SYS-006] + A3[管理后台/SYS-001] + A4[微网厅/SYS-004] + A5[外部系统/SYS-008] end subgraph L2["接入层"] @@ -885,15 +888,15 @@ graph TB | 子系统编号 | 子系统名称(标识) | 功能描述 | 开发方式 | |---|---|---|---| -| SYS-001 | 统一平台 | 单点登录、系统管理、权限管理、租户管理 | 自行开发 | +| SYS-001 | 统一平台 | 单点登录、统一认证(SSO/OAuth2+CAS)、审计与监控、权限、组织、参数、多租户、字典等基础能力 | 自行开发 | | SYS-002 | 营收业务系统 | 客户管理、抄表开账、营业收费、账务处理、发票管理、催缴管理、统计分析、代收业务、客户服务、业务参数配置 | 自行开发 | -| SYS-003 | 手机抄表APP | 移动端抄表、现场作业、数据同步、离线支持 | 自行开发 | +| SYS-003 | 手机抄表APP | 移动端抄表、AI抄表读数识别、现场作业、数据同步、离线支持 | 自行开发 | | SYS-004 | 微网厅系统 | 微信公众号平台、账户绑定、在线缴费、信息查询、业务办理、网点服务 | 自行开发 | | SYS-005 | 工单管理系统 | 统一工单中心、工单流程引擎、监控预警、绩效统计 | 自行开发 | -| SYS-006 | 表务管理系统 | 表务基础管理、仓库与库存管理、设备档案管理 | 自行开发 | -| SYS-007 | 报装业务系统 | 报装流程管理、工程管理、档案管理 | 自行开发 | +| SYS-006 | 表务管理系统 | 设备档案、表务全生命周期管理 | 自行开发 | +| SYS-007 | 报装业务系统 | 报装流程管理、合同签订与电子签章、工程管理、档案管理 | 自行开发 | | SYS-008 | 发票服务子系统 | 统一开票网关、供应商适配器(优先对接航天)、回执处理与存证 | 自行开发 | -| SYS-009 | 支付与银行结算子系统 | 聚合支付/退款、渠道适配(微信/支付宝/银联)、支付通知、银行代扣送盘/回盘、对账处理、加解密签名 | 自行开发 | +| SYS-009 | 支付与银行结算子系统 | 聚合支付/退款、渠道适配(微信/支付宝/银联)、支付通知、银行代扣送盘/回盘、夜间批量代扣、对账处理、加解密签名 | 自行开发 | | SYS-010 | 消息服务子系统 | 短信/邮件/站内信模板与发送、回执查询、批量推送 | 自行开发 | ### 子系统间关系 @@ -903,7 +906,7 @@ graph TB ```mermaid graph TB subgraph "SYS-001 统一平台" - UP[用户权限管理
组织架构管理
系统配置管理
单点登录] + UP[单点登录
统一认证SSO/OAuth2+CAS
审计监控
权限、组织
参数、多租户
字典管理] end subgraph "SYS-002 营收业务系统" @@ -917,7 +920,7 @@ graph TB end subgraph "SYS-003 手机抄表APP" - APP[移动抄表
现场作业
数据同步
离线支持] + APP[移动抄表
AI读数识别
现场作业
数据同步
离线支持] end subgraph "SYS-004 微网厅系统" @@ -929,11 +932,11 @@ graph TB end subgraph "SYS-006 表务管理系统" - METER_SYS[表务基础
库存管理
设备档案] + METER_SYS[设备档案
表务全生命周期管理] end subgraph "SYS-007 报装业务系统" - INSTALL_SYS[报装流程
工程管理
档案管理] + INSTALL_SYS[报装流程
合同签订与电子签章
工程管理
档案管理] end subgraph "SYS-008 发票服务子系统" @@ -1098,7 +1101,7 @@ graph TB ## 任务概述 -统一平台是整个营业收费系统的基础支撑平台,负责为所有子系统提供统一的用户认证、权限管理、组织管理等基础服务。 +统一平台是整个福建水务营收系统的基础支撑平台,负责为所有子系统提供统一的用户认证、权限管理、组织管理等基础服务。 **设计目标:** @@ -1338,11 +1341,11 @@ graph TB ## 任务概述 -营收业务系统是整个营业收费系统的核心业务系统,负责处理从客户管理到账务处理的完整营收业务流程,整合了原营收系统、表务系统、报装系统、客户服务、微网厅等所有核心业务功能。 +营收业务系统是整个福建水务营收系统的核心业务系统,负责处理从客户管理到账务处理的完整营收业务流程,整合了原营收系统、表务系统、报装系统、客户服务、微网厅等所有核心业务功能。 **设计目标:** -- 实现统一的营收业务管理平台,涵盖水务企业全业务场景 +- 实现统一的营收业务管理,涵盖水务企业全业务场景 - 提供完整的客户服务体验,从线下到线上的全渠道服务 - 支持表务全生命周期管理,确保设备资产的有效管控 - 实现报装业务流程标准化,提高服务效率和客户满意度 @@ -1961,7 +1964,7 @@ flowchart TD ## 任务概述 -手机抄表APP为抄表员、外勤人员提供移动作业工具,支持离线操作,提升现场工作效率。 +手机抄表APP为抄表员、外勤人员提供移动作业工具,支持离线操作,并集成摄像表AI功能实现抄表读数自动识别,提升现场工作效率。 **设计目标:** @@ -2072,11 +2075,27 @@ graph TB ```mermaid graph TD - MOBILE-001 --> MOBILE-003 - MOBILE-002 --> MOBILE-003 - MOBILE-003 --> MOBILE-006 - MOBILE-004 --> MOBILE-006 - MOBILE-005 -.-> MOBILE-006 + subgraph "手机抄表APP模块关系" + A[MOBILE-001
登录认证] + B[MOBILE-002
首页搜索] + C[MOBILE-003
采集任务管理] + D[MOBILE-004
现场上报] + E[MOBILE-005
个人与设置] + F[MOBILE-006
数据同步] + end + + A -->|认证通过| C + B -->|搜索定位| C + C -->|任务数据| F + D -->|上报数据| F + E -.->|配置同步| F + + %% 样式定义 + classDef coreModule fill:#e3f2fd,stroke:#1976d2,stroke-width:2px + classDef syncModule fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px + + class A,B,C,D coreModule + class E,F syncModule ``` ### 模块描述 @@ -2207,16 +2226,38 @@ graph TB ```mermaid graph TD - BIND[账户绑定管理] --> QUERY[信息查询服务] - BIND --> PAY[在线缴费服务] - BIND --> INVOICE[电子发票服务] - BIND --> OUTLET[营业网点服务] - BIND --> SERVICE[业务办理服务] + subgraph "微网厅系统模块关系" + A[WECHAT-001
账户绑定管理] + B[WECHAT-002
信息查询服务] + C[WECHAT-003
在线缴费服务] + D[WECHAT-004
电子发票服务] + E[WECHAT-005
营业网点服务] + F[WECHAT-006
业务办理服务] + G[WECHAT-007
账户流水] + H[WECHAT-008
账号与机构管理] + end - QUERY --> INVOICE - PAY --> INVOICE - SERVICE --> QUERY - SERVICE --> PAY + A -->|身份验证| B + A -->|授权支付| C + A -->|授权开票| D + A -->|位置服务| E + A -->|业务授权| F + A -->|流水授权| G + A -->|账号管理| H + + B -.->|查询后开票| D + C -.->|支付后开票| D + F -.->|业务查询| B + F -.->|业务缴费| C + + %% 样式定义 + classDef coreService fill:#e3f2fd,stroke:#1976d2,stroke-width:2px + classDef supportService fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px + classDef bindingModule fill:#fff3e0,stroke:#f57c00,stroke-width:2px + + class A bindingModule + class B,C,D,F coreService + class E,G,H supportService ``` ### 模块描述 @@ -2502,11 +2543,27 @@ graph TB ```mermaid graph TD - WO-CORE --> WO-FLOW - WO-CORE --> WO-MON - WO-CORE --> WO-STAT - WO-FLOW -.-> WO-MON - WO-MON -.-> WO-STAT + subgraph "工单管理系统模块关系" + A[WO-CORE
工单中心] + B[WO-FLOW
流程引擎] + C[WO-MON
监控预警] + D[WO-STAT
绩效统计] + end + + A -->|流程调度| B + A -->|状态监控| C + A -->|数据统计| D + B -.->|流程状态| C + C -.->|监控数据| D + + %% 样式定义 + classDef coreModule fill:#e3f2fd,stroke:#1976d2,stroke-width:2px + classDef processModule fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px + classDef monitorModule fill:#fff3e0,stroke:#f57c00,stroke-width:2px + + class A coreModule + class B processModule + class C,D monitorModule ``` ### 模块描述 @@ -2520,7 +2577,7 @@ graph TD ## 任务概述 -表务管理系统(SYS-006)聚焦水表资产全生命周期管理与库存管理,提供基础数据、仓储、档案三大能力,面向换表等业务提供资源保障。 +表务管理系统(SYS-006)聚焦设备档案和表务全生命周期管理,面向换表等业务提供资源保障。 ## 设计概述 @@ -2562,8 +2619,24 @@ graph TB ```mermaid graph TD - METER-BASE --> METER-WH --> METER-DOC - METER-DOC -.-> METER-BASE + subgraph "表务管理系统模块关系" + A[METER-BASE
表务基础管理] + B[METER-WH
仓库与库存管理] + C[METER-DOC
设备档案管理] + end + + A -->|基础参数| B + B -->|库存状态| C + C -.->|规格验证| A + + %% 样式定义 + classDef baseModule fill:#e3f2fd,stroke:#1976d2,stroke-width:2px + classDef warehouseModule fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px + classDef docModule fill:#fff3e0,stroke:#f57c00,stroke-width:2px + + class A baseModule + class B warehouseModule + class C docModule ``` ### 模块描述 @@ -2576,7 +2649,7 @@ graph TD ## 任务概述 -报装业务系统(SYS-007)覆盖从申请、踏勘、设计、施工到验收通水的全流程,并与工单系统协作完成现场派工与过程留痕。 +报装业务系统(SYS-007)覆盖从申请、踏勘、设计、施工到验收通水的全流程,支持调用泛微进行合同签订和电子签章,并与工单系统协作完成现场派工与过程留痕。 ## 设计概述 @@ -2667,7 +2740,7 @@ graph TB subgraph "供应商" HT[航天信息] - BOS[博思(预留)] + BOS[博思/预留] end REV -.->|INV-001/002/003| GW @@ -2690,8 +2763,26 @@ graph TB ```mermaid graph TD - INV-GW --> INV-ADP --> INV-RCPT --> INV-EVID - INV-RCPT -.-> INV-GW + subgraph "发票服务子系统模块关系" + A[INV-GW
统一开票网关] + B[INV-ADP
供应商适配器] + C[INV-RCPT
回执处理] + D[INV-EVID
存证与签章] + end + + A -->|请求路由| B + B -->|供应商回调| C + C -->|状态更新| D + C -.->|状态回馈| A + + %% 样式定义 + classDef gatewayModule fill:#e3f2fd,stroke:#1976d2,stroke-width:2px + classDef adapterModule fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px + classDef processModule fill:#fff3e0,stroke:#f57c00,stroke-width:2px + + class A gatewayModule + class B adapterModule + class C,D processModule ``` ### 模块描述 @@ -2705,8 +2796,24 @@ graph TD ```mermaid graph TD - INST-FLOW --> INST-PROJ --> INST-ARCH - INST-FLOW -.-> INST-ARCH + subgraph "报装业务系统模块关系" + A[INST-FLOW
报装流程管理] + B[INST-PROJ
工程管理] + C[INST-ARCH
档案管理] + end + + A -->|流程推进| B + B -->|资料归档| C + A -.->|过程留痕| C + + %% 样式定义 + classDef flowModule fill:#e3f2fd,stroke:#1976d2,stroke-width:2px + classDef projectModule fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px + classDef archiveModule fill:#fff3e0,stroke:#f57c00,stroke-width:2px + + class A flowModule + class B projectModule + class C archiveModule ``` ### 模块描述 @@ -2719,7 +2826,7 @@ graph TD ## 任务概述 -支付与银行结算子系统(SYS-009)统一承载聚合支付/退款、渠道适配(微信/支付宝/银联聚合)、支付回调验签入账,以及银行代扣(送盘/回盘)、对账文件处理与安全加解密/签名,向上对营收/微网厅等系统提供标准化支付与结算能力。 +支付与银行结算子系统(SYS-009)统一承载聚合支付/退款、渠道适配(微信/支付宝/银联聚合)、支付回调验签入账,以及银行代扣(送盘/回盘)、支持夜间进行批量代扣、对账文件处理与安全加解密/签名,向上对营收/微网厅等系统提供标准化支付与结算能力。 ## 设计概述 @@ -2799,12 +2906,37 @@ graph TB ```mermaid graph TD - PAY-GW --> PAY-ADP-CH --> PAY-ADP-BANK --> PAY-CB --> PAY-RECON --> PAY-CRYPTO - PAY-ADP-CH -.-> PAY-GW - PAY-ADP-BANK -.-> PAY-GW - PAY-CB -.-> PAY-GW - PAY-RECON -.-> PAY-GW - PAY-CRYPTO -.-> PAY-GW + subgraph "支付与银行结算子系统模块关系" + A[PAY-GW
统一支付与结算网关] + B[PAY-ADP-CH
渠道适配器] + C[PAY-ADP-BANK
银行适配器] + D[PAY-CB
回调处理] + E[PAY-RECON
批量对账处理] + F[PAY-CRYPTO
加解密/签名] + end + + A -->|渠道路由| B + A -->|银行对接| C + B -->|支付回调| D + C -->|对账数据| E + A -->|安全加密| F + + B -.->|状态反馈| A + C -.->|状态反馈| A + D -.->|结果通知| A + E -.->|对账结果| A + F -.->|密钥服务| A + + %% 样式定义 + classDef gatewayModule fill:#e3f2fd,stroke:#1976d2,stroke-width:2px + classDef adapterModule fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px + classDef processModule fill:#fff3e0,stroke:#f57c00,stroke-width:2px + classDef securityModule fill:#e8f5e8,stroke:#388e3c,stroke-width:2px + + class A gatewayModule + class B,C adapterModule + class D,E processModule + class F securityModule ``` ### 模块描述 @@ -2903,7 +3035,19 @@ graph TB ```mermaid graph TD - MSG-PUB --> MSG-SUB + subgraph "消息服务子系统模块关系" + A[MSG-PUB
消息推送] + B[MSG-SUB
消息订阅] + end + + A -->|消息分发| B + + %% 样式定义 + classDef publishModule fill:#e3f2fd,stroke:#1976d2,stroke-width:2px + classDef subscribeModule fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px + + class A publishModule + class B subscribeModule ``` ### 模块描述 diff --git a/新-详细设计说明书.md b/新-详细设计说明书.md index 45b52c5..70b7a2d 100644 --- a/新-详细设计说明书.md +++ b/新-详细设计说明书.md @@ -1,4 +1,4 @@ -# 福建水务数智营收管理系统详细设计说明书 +# 福建水务营收系统详细设计说明书 | 文件状态: | 文档密级: | 公开 | | :--- | :--- | :--- | @@ -22,7 +22,7 @@ # 目录 -- [福建水务数智营收管理系统详细设计说明书](#福建水务数智营收管理系统详细设计说明书) +- [福建水务营收系统详细设计说明书](#福建水务营收系统详细设计说明书) - [版本历史](#版本历史) - [目录](#目录) - [前言](#前言) @@ -466,7 +466,7 @@ ## 编写目的 -本文档在《概要设计说明书》的基础上,对福建水务数智营收管理系统的各核心子系统及模块进行详细的功能设计、流程设计和技术实现说明。 +本文档在《概要设计说明书》的基础上,对福建水务营收系统的各核心子系统及模块进行详细的功能设计、流程设计和技术实现说明。 本文档主要用途: - 为开发团队提供详细的技术实现指导 @@ -482,7 +482,7 @@ ## 背景与任务 -福建水务数智营收管理系统是为满足福建省水投数字科技有限公司客户服务管理领域的业务需求而建设的综合管理平台。系统以客户关系数据库为核心和基础,实现客户全生命周期管理。 +福建水务营收系统是为满足福建省水投数字科技有限公司客户服务管理领域的业务需求而建设的综合管理平台。系统以客户关系数据库为核心和基础,实现客户全生命周期管理。 ### 建设背景 @@ -518,10 +518,10 @@ ## 参考资料 -- 《福建水务数智营收管理系统需求规格说明书》 -- 《福建水务数智营收管理系统概要设计说明书》 -- 《福建水务数智营收管理系统数据库设计说明书》 -- 《福建水务数智营收管理系统接口设计说明书》 +- 《福建水务营收系统需求规格说明书》 +- 《福建水务营收系统概要设计说明书》 +- 《福建水务营收系统数据库设计说明书》 +- 《福建水务营收系统接口设计说明书》 - GB/T 8556-2007 信息技术软件生存周期过程 - GB/T 9385-2008 计算机软件需求规格说明规范 - GB/T 8567-2006 计算机软件文档编制规范