docs: 重组详细设计目录并标准化导航锚点
This commit is contained in:
parent
375f9e5482
commit
d2e0b1aa70
@ -36,8 +36,8 @@
|
||||
### 02\_详细设计 (Detailed)
|
||||
|
||||
- [🔧 详细设计说明书](docs/design/02_Detailed_Design/01_Detailed_Design.md)
|
||||
- [🔧 模块功能设计](docs/design/02_Detailed_Design/02_Module_Design.md)
|
||||
- [🔧 报装CA集成设计](docs/design/02_Detailed_Design/03_CA_Installation_Design.md)
|
||||
- [🔧 模块追溯索引](docs/design/02_Detailed_Design/02_Module_Traceability_Index.md)
|
||||
- [🔧 报装CA电子签章补充](docs/design/02_Detailed_Design/03_CA_Esignature_Supplement.md)
|
||||
|
||||
### 03\_技术专项 (Technical)
|
||||
|
||||
|
||||
@ -111,6 +111,7 @@
|
||||
|
||||
| 变更时间 | 变更类型 | 变更内容 | 变更原因 | 影响评估 |
|
||||
| ---------- | ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| 2026-03-11 | `02_Detailed_Design` 结构重组与主稿导航标准化 | 对 `docs/design/02_Detailed_Design/` 执行“单一真源 + 专项补充”重构:1)将并行稿迁入归档(`04_Appendix/Archive/03_Design_Docs/02_Module_Design_legacy_20260311.md`、`03_CA_Installation_Design_legacy_20260311.md`);2)新增 `02_Module_Traceability_Index.md`(模块-接口-数据域追溯索引)与 `03_CA_Esignature_Supplement.md`(报装电子签章专项补充);3)重写 `01_Detailed_Design.md` 顶部为“章节导航(精简)”并补齐稳定锚点(`sec-preface`、`sec-overall-design`、`sec-module-detail`、`sec-platform-detail`、`sec-revenue-detail`、`sec-customer-detail`、`sec-meter-detail`、`sec-installation-detail`、`sec-database-detail`、`sec-interface-detail`、`sec-security-detail`、`sec-deployment-detail`、`sec-appendix`);4)同步更新 README、导出脚本与附录引用。 | 用户确认按重组方案执行,要求解决 `02_Detailed_Design` 混乱问题并形成可长期维护结构 | 正面影响,详细设计目录职责边界明确:主详设聚焦权威正文,索引与CA细节分离;旧并行稿退出正式入口,口径冲突与维护噪音显著降低;章节定位和 AI 检索稳定性提升。 |
|
||||
| 2026-03-11 | `03_Summary_Design` 导航精简与锚点标准化 | 在 `docs/design/01_Overview/03_Summary_Design.md` 中将顶部导航收敛为“章节导航(精简)”,移除冗长目录块,建立稳定锚点体系(`sec-preface`、`sec-overall-design`、`sec-subsystems`、`sec-sys-001~010`、`sec-nfr`)并同步章节跳转链接;执行 `make validate-file FILE=docs/design/01_Overview/03_Summary_Design.md`、`make check-links`、`make validate-mermaid`、`make check-ai-governance`。 | 用户要求“章节导航精简 + 锚点标准化”,并希望直接落地可执行结果 | 正面影响,超长主文档定位成本显著下降,章节跳转稳定性提升,后续标题调整时链接不易失效,便于 AI 检索与评审维护。 |
|
||||
| 2026-03-11 | `01_Overview` 三文档深度重写 | 按“主文档单一真源、支撑文档不重复”原则重写 `docs/design/01_Overview/01_System_Overview.md`、`docs/design/01_Overview/02_System_Architecture.md`、`docs/design/01_Overview/04_System_Diagrams.md`:1)`01` 收敛为背景/目标/范围/术语导览,移除实现细节;2)`02` 收敛为总体架构原则、子系统边界与协同规则,统一数据库口径为达梦数据库 8.0+;3)`04` 重建为图谱目录 + 三张总体图,并修复旧图中重复节点标识问题;同步完成 `validate-file`、`check-links`、`validate-mermaid`、`check-ai-governance` 校验 | 用户要求对 `docs/design/01_Overview` 混乱状态进行重写,形成可维护、可交付、可对齐主稿的总体层结构 | 正面影响,`01_Overview` 目录实现“导览文档 + 架构文档 + 图谱文档”分工清晰,重复内容显著减少,口径冲突(尤其数据库选型)已消除,后续评审和维护成本下降 |
|
||||
| 2026-03-11 | `01_Overview` 目录治理与结构澄清 | 对 `docs/design/01_Overview/` 实施轻量治理:重写目录说明 `README.md`,明确四个文件的职责边界与阅读顺序;为 `01_System_Overview.md`、`02_System_Architecture.md`、`04_System_Diagrams.md` 补充 Front Matter 元数据(文档角色、权威级别、检索优先级);修复 `01_System_Overview.md` 中迁移遗留的旧路径引用(`../02_Detailed/`、`../03_Technical/` → 新目录路径);补充 `04_System_Diagrams.md` 的标题与文档定位说明,统一图文关系 | 用户反馈 `docs/design/01_Overview` 文件混乱,需要先完成目录职责澄清和基础可维护性治理 | 正面影响,总体设计目录从“文件并列”升级为“主稿+支撑文档”结构,文档职责与入口更清晰;迁移残留链接已清理,AI 检索与人工维护成本同步下降 |
|
||||
|
||||
@ -138,6 +138,16 @@
|
||||
|
||||
## ✅ 最新完成任务 (持续更新)
|
||||
|
||||
### 📋 `02_Detailed_Design` 重组治理(主稿单一真源)
|
||||
|
||||
- [x] **完成详细设计目录重组与文件治理** ✅ (2026-03-11)
|
||||
- [x] 将 `02_Module_Design.md`、`03_CA_Installation_Design.md` 迁入 `docs/design/04_Appendix/Archive/03_Design_Docs/` 归档 ✅
|
||||
- [x] 新增 `02_Module_Traceability_Index.md`,建立模块-接口-数据域追溯索引 ✅
|
||||
- [x] 新增 `03_CA_Esignature_Supplement.md`,收敛报装电子签章专项补充内容 ✅
|
||||
- [x] 重写 `01_Detailed_Design.md` 顶部导航为“章节导航(精简)”,并补齐稳定锚点体系 ✅
|
||||
- [x] 更新 `README.md`、`docs/design/02_Detailed_Design/README.md`、`scripts/unified_export.sh`、`docs/design/04_Appendix/03_CA_Integration_Summary.md` 引用 ✅
|
||||
- [x] 更新项目进度文件记录本次重组动作 ✅
|
||||
|
||||
### 📋 `03_Summary_Design` 章节导航精简与锚点标准化
|
||||
|
||||
- [x] **完成概要主文档导航收敛与稳定锚点改造** ✅ (2026-03-11)
|
||||
|
||||
@ -30,86 +30,23 @@ retrieval_priority: P0
|
||||
| 2025-08-01 | V1.4 | 唐伟杰 | 单点登录采用 OAuth2.0 协议,补充统一认证相关设计。 |
|
||||
| 2026-03-10 | V1.6 | 唐伟杰 | 将分散的模块设计、数据库设计、接口设计、安全设计、部署设计与报装电子签章设计整合为统一主详设,统一系统名称、章节体系、模块/接口编号及数据库口径,清理重复内容与部署脏片段。 |
|
||||
|
||||
# 目录
|
||||
## 章节导航(精简)
|
||||
|
||||
- [福建水务营收系统详细设计说明书](#福建水务营收系统详细设计说明书)
|
||||
- [版本历史](#版本历史)
|
||||
- [目录](#目录)
|
||||
- [前言](#前言)
|
||||
- [编写目的](#编写目的)
|
||||
- [建设背景](#建设背景)
|
||||
- [设计范围](#设计范围)
|
||||
- [术语与缩略语](#术语与缩略语)
|
||||
- [参考资料](#参考资料)
|
||||
- [系统总体设计](#系统总体设计)
|
||||
- [总体目标](#总体目标)
|
||||
- [逻辑架构设计](#逻辑架构设计)
|
||||
- [部署分区设计](#部署分区设计)
|
||||
- [子系统与模块划分](#子系统与模块划分)
|
||||
- [统一平台详细设计](#统一平台详细设计)
|
||||
- [UP-001 统一认证与单点登录](#up-001-统一认证与单点登录)
|
||||
- [UP-002 组织用户与权限管理](#up-002-组织用户与权限管理)
|
||||
- [UP-003 参数字典与基础配置](#up-003-参数字典与基础配置)
|
||||
- [UP-004 审计监控与运维支撑](#up-004-审计监控与运维支撑)
|
||||
- [营收业务详细设计](#营收业务详细设计)
|
||||
- [REV-001 客户资料管理](#rev-001-客户资料管理)
|
||||
- [REV-002 抄表开账](#rev-002-抄表开账)
|
||||
- [REV-003 营业收费](#rev-003-营业收费)
|
||||
- [REV-004 账务处理](#rev-004-账务处理)
|
||||
- [REV-005 发票与税务处理](#rev-005-发票与税务处理)
|
||||
- [REV-006 催缴与通知](#rev-006-催缴与通知)
|
||||
- [REV-007 统计分析](#rev-007-统计分析)
|
||||
- [REV-008 代收与银行业务](#rev-008-代收与银行业务)
|
||||
- [REV-009 业务参数配置](#rev-009-业务参数配置)
|
||||
- [表务详细设计](#表务详细设计)
|
||||
- [METER-001 表务基础管理](#meter-001-表务基础管理)
|
||||
- [METER-002 表务工单管理](#meter-002-表务工单管理)
|
||||
- [METER-003 仓储与生命周期管理](#meter-003-仓储与生命周期管理)
|
||||
- [METER-004 物联网接入与数据同步](#meter-004-物联网接入与数据同步)
|
||||
- [报装与签章详细设计](#报装与签章详细设计)
|
||||
- [INST-001 报装申请与受理](#inst-001-报装申请与受理)
|
||||
- [INST-002 现场踏勘与方案设计](#inst-002-现场踏勘与方案设计)
|
||||
- [INST-003 施工验收与立户通水](#inst-003-施工验收与立户通水)
|
||||
- [INST-004 合同签署与电子签章](#inst-004-合同签署与电子签章)
|
||||
- [INST-005 档案归档与过程留痕](#inst-005-档案归档与过程留痕)
|
||||
- [客户服务模块详细设计](#客户服务模块详细设计)
|
||||
- [CS-001 账户绑定管理](#cs-001-账户绑定管理)
|
||||
- [CS-002 信息查询服务](#cs-002-信息查询服务)
|
||||
- [CS-003 在线缴费服务](#cs-003-在线缴费服务)
|
||||
- [CS-004 电子发票服务](#cs-004-电子发票服务)
|
||||
- [CS-005 营业网点服务](#cs-005-营业网点服务)
|
||||
- [CS-006 业务办理服务](#cs-006-业务办理服务)
|
||||
- [CS-007 柜面扫码支付](#cs-007-柜面扫码支付)
|
||||
- [数据库详细设计](#数据库详细设计)
|
||||
- [数据库选型与原则](#数据库选型与原则)
|
||||
- [数据库逻辑架构](#数据库逻辑架构)
|
||||
- [核心数据模型](#核心数据模型)
|
||||
- [核心数据表设计](#核心数据表设计)
|
||||
- [索引与性能设计](#索引与性能设计)
|
||||
- [接口详细设计](#接口详细设计)
|
||||
- [接口设计原则](#接口设计原则)
|
||||
- [统一平台接口](#统一平台接口)
|
||||
- [营收业务接口](#营收业务接口)
|
||||
- [表务与物联网接口](#表务与物联网接口)
|
||||
- [报装与签章接口](#报装与签章接口)
|
||||
- [客户渠道接口](#客户渠道接口)
|
||||
- [外部系统接口](#外部系统接口)
|
||||
- [安全详细设计](#安全详细设计)
|
||||
- [安全目标与分层防护](#安全目标与分层防护)
|
||||
- [身份认证与访问控制](#身份认证与访问控制)
|
||||
- [数据安全与隐私保护](#数据安全与隐私保护)
|
||||
- [接口安全与审计追踪](#接口安全与审计追踪)
|
||||
- [安全运营与应急响应](#安全运营与应急响应)
|
||||
- [部署与运维设计](#部署与运维设计)
|
||||
- [部署总体方案](#部署总体方案)
|
||||
- [环境规划](#环境规划)
|
||||
- [网络与分区设计](#网络与分区设计)
|
||||
- [监控告警与日志](#监控告警与日志)
|
||||
- [备份恢复与发布管理](#备份恢复与发布管理)
|
||||
- [附录](#附录)
|
||||
- [附录A 模块编号说明](#附录a-模块编号说明)
|
||||
- [附录B 接口编号说明](#附录b-接口编号说明)
|
||||
- [附录C 设计约束与统一口径](#附录c-设计约束与统一口径)
|
||||
- [前言](#sec-preface)
|
||||
- [系统总体设计](#sec-overall-design)
|
||||
- [详细模块设计](#sec-module-detail)
|
||||
- [统一平台详细设计](#sec-platform-detail)
|
||||
- [营收业务详细设计](#sec-revenue-detail)
|
||||
- [客户服务模块详细设计](#sec-customer-detail)
|
||||
- [表务详细设计](#sec-meter-detail)
|
||||
- [报装与签章详细设计](#sec-installation-detail)
|
||||
- [数据库详细设计](#sec-database-detail)
|
||||
- [接口详细设计](#sec-interface-detail)
|
||||
- [安全详细设计](#sec-security-detail)
|
||||
- [部署与运维设计](#sec-deployment-detail)
|
||||
- [附录](#sec-appendix)
|
||||
|
||||
<a id="sec-preface"></a>
|
||||
|
||||
# 前言
|
||||
|
||||
@ -147,8 +84,8 @@ retrieval_priority: P0
|
||||
## 参考资料
|
||||
|
||||
1. 《福建水务营收系统概要设计相关文档》
|
||||
2. `docs/design/02_Detailed_Design/02_Module_Design.md`
|
||||
3. `docs/design/02_Detailed_Design/03_CA_Installation_Design.md`
|
||||
2. `docs/design/02_Detailed_Design/02_Module_Traceability_Index.md`
|
||||
3. `docs/design/02_Detailed_Design/03_CA_Esignature_Supplement.md`
|
||||
4. `docs/design/03_Technical_Design/01_Database_Design.md`
|
||||
5. `docs/design/03_Technical_Design/02_Table_Specs.md`
|
||||
6. `docs/design/03_Technical_Design/03_Interface_Design.md`
|
||||
@ -156,6 +93,8 @@ retrieval_priority: P0
|
||||
8. `docs/design/03_Technical_Design/05_Deployment_Design.md`
|
||||
9. 福建水投相关业务操作手册及需求说明资料
|
||||
|
||||
<a id="sec-overall-design"></a>
|
||||
|
||||
# 系统总体设计
|
||||
|
||||
## 总体目标
|
||||
@ -282,6 +221,9 @@ graph TB
|
||||
| 报装与签章 | 覆盖受理、踏勘、施工、签约、电子签章、归档 | INST-001 ~ INST-005 |
|
||||
| 客户服务模块 | 覆盖账户绑定、信息查询、在线缴费、电子发票、网点服务、业务办理与柜面扫码支付 | CS-001 ~ CS-007 |
|
||||
|
||||
<a id="sec-module-detail"></a>
|
||||
<a id="sec-platform-detail"></a>
|
||||
|
||||
# 统一平台详细设计
|
||||
|
||||
## UP-001 统一认证与单点登录
|
||||
@ -370,6 +312,8 @@ UP-004 提供操作日志、登录日志、接口日志、异常监控、在线
|
||||
3. 定时任务执行结果、失败重试与人工补偿过程可追踪。
|
||||
4. 监控与告警支持短信、邮件、站内信等通知方式。
|
||||
|
||||
<a id="sec-revenue-detail"></a>
|
||||
|
||||
# 营收业务详细设计
|
||||
|
||||
## REV-001 客户资料管理
|
||||
@ -666,6 +610,8 @@ flowchart TD
|
||||
- `biz_price_category`、`biz_price_template`、`biz_template_dept_rel`:价格归属与模板站点关系。
|
||||
- `biz_cust_no_rule`:客户编号规则。
|
||||
|
||||
<a id="sec-customer-detail"></a>
|
||||
|
||||
# 客户服务模块详细设计
|
||||
|
||||
## CS-001 账户绑定管理
|
||||
@ -785,6 +731,8 @@ flowchart TD
|
||||
- `bk_transaction`
|
||||
- `bk_transaction_callback`
|
||||
|
||||
<a id="sec-meter-detail"></a>
|
||||
|
||||
# 表务详细设计
|
||||
|
||||
## METER-001 表务基础管理
|
||||
@ -843,6 +791,8 @@ flowchart TD
|
||||
G --> I[人工复核处理]
|
||||
```
|
||||
|
||||
<a id="sec-installation-detail"></a>
|
||||
|
||||
# 报装与签章详细设计
|
||||
|
||||
## INST-001 报装申请与受理
|
||||
@ -962,6 +912,8 @@ sequenceDiagram
|
||||
- 电子签章合同、验收附件、影像资料统一存储。
|
||||
- 档案查询支持按申请编号、客户、地址、时间、状态检索。
|
||||
|
||||
<a id="sec-database-detail"></a>
|
||||
|
||||
# 数据库详细设计
|
||||
|
||||
## 数据库选型与原则
|
||||
@ -1085,6 +1037,8 @@ erDiagram
|
||||
3. 时间分区:账单、缴费、日志等大表按月或按年管理归档。
|
||||
4. 热点缓存:参数字典、用户会话、移动端任务、发票状态等进入 Redis。
|
||||
|
||||
<a id="sec-interface-detail"></a>
|
||||
|
||||
# 接口详细设计
|
||||
|
||||
## 接口设计原则
|
||||
@ -1181,6 +1135,8 @@ erDiagram
|
||||
| EXT-CA-003 | 时间戳接口 | 申请签署时间戳 | HTTPS REST | 文档哈希 | 时间戳凭证 |
|
||||
| EXT-CA-004 | 电子存证接口 | 存储签署后合同 | HTTPS REST | 签署文档、元数据 | 存证凭证 |
|
||||
|
||||
<a id="sec-security-detail"></a>
|
||||
|
||||
# 安全详细设计
|
||||
|
||||
## 安全目标与分层防护
|
||||
@ -1223,6 +1179,8 @@ graph TB
|
||||
2. 按 P0~P3 级别定义安全事件处置流程。
|
||||
3. 定期进行漏洞扫描、补丁更新、备份恢复演练和权限审计。
|
||||
|
||||
<a id="sec-deployment-detail"></a>
|
||||
|
||||
# 部署与运维设计
|
||||
|
||||
## 部署总体方案
|
||||
@ -1287,6 +1245,8 @@ graph TB
|
||||
3. 发布采用版本化管理,执行发布审批、健康检查、回滚预案。
|
||||
4. 对支付、签章、银行代扣等关键链路执行灰度验证前置检查,但生产方案不保留脚本碎片或临时配置片段。
|
||||
|
||||
<a id="sec-appendix"></a>
|
||||
|
||||
# 附录
|
||||
|
||||
## 附录A 模块编号说明
|
||||
|
||||
108
docs/design/02_Detailed_Design/02_Module_Traceability_Index.md
Normal file
108
docs/design/02_Detailed_Design/02_Module_Traceability_Index.md
Normal file
@ -0,0 +1,108 @@
|
||||
---
|
||||
doc_id: DT-02-TRACE
|
||||
doc_role: support_document
|
||||
authority: secondary
|
||||
scope: 详细设计追溯索引
|
||||
source_of_truth: false
|
||||
last_reviewed: 2026-03-11
|
||||
retrieval_priority: P1
|
||||
---
|
||||
|
||||
# 福建水务营收系统模块追溯索引
|
||||
|
||||
## 章节导航(精简)
|
||||
|
||||
- [文档定位](#sec-position)
|
||||
- [追溯使用规则](#sec-rules)
|
||||
- [子系统级追溯矩阵](#sec-subsystem-matrix)
|
||||
- [模块级追溯矩阵](#sec-module-matrix)
|
||||
- [维护机制](#sec-maintenance)
|
||||
|
||||
<a id="sec-position"></a>
|
||||
|
||||
## 文档定位
|
||||
|
||||
本文档用于提供“模块编号 → 主详设章节 → 关键接口 → 关键数据域”的统一检索入口,服务于:
|
||||
|
||||
1. 需求评审与影响范围分析;
|
||||
2. 开发联调阶段的问题定位;
|
||||
3. AI Agent 检索时的快速跳转。
|
||||
|
||||
边界说明:
|
||||
|
||||
- 本文档是追溯索引,不替代主详设内容;
|
||||
- 详细设计权威口径以 `01_Detailed_Design.md` 为准;
|
||||
- 数据表字段定义以 `03_Technical_Design/01_Database_Design.md`、`03_Technical_Design/02_Table_Specs.md` 为准;
|
||||
- 接口参数细项以 `03_Technical_Design/03_Interface_Design.md` 为准。
|
||||
|
||||
<a id="sec-rules"></a>
|
||||
|
||||
## 追溯使用规则
|
||||
|
||||
1. 先按模块编号定位至主详设章节,再查看接口与数据域映射;
|
||||
2. 发现模块描述与接口/数据口径冲突时,以主详设为第一参照,并同步修订技术专项文档;
|
||||
3. 本文档仅保留“可追溯最小必要信息”,不重复搬运完整设计正文;
|
||||
4. 基础服务子系统(SYS-008/009/010)在详细设计层按接口协同描述,不在此索引中虚增平行模块。
|
||||
|
||||
<a id="sec-subsystem-matrix"></a>
|
||||
|
||||
## 子系统级追溯矩阵
|
||||
|
||||
| 子系统/能力域 | 模块范围 | 主详设章节 | 主要技术专题 |
|
||||
|---|---|---|---|
|
||||
| 统一平台 | `UP-001 ~ UP-004` | [统一平台详细设计](./01_Detailed_Design.md#sec-platform-detail) | [接口设计](../03_Technical_Design/03_Interface_Design.md)、[安全设计](../03_Technical_Design/04_Security_Design.md) |
|
||||
| 营收业务 | `REV-001 ~ REV-009` | [营收业务详细设计](./01_Detailed_Design.md#sec-revenue-detail) | [数据库设计](../03_Technical_Design/01_Database_Design.md)、[接口设计](../03_Technical_Design/03_Interface_Design.md) |
|
||||
| 客户服务 | `CS-001 ~ CS-007` | [客户服务模块详细设计](./01_Detailed_Design.md#sec-customer-detail) | [接口设计](../03_Technical_Design/03_Interface_Design.md)、[安全设计](../03_Technical_Design/04_Security_Design.md) |
|
||||
| 表务管理 | `METER-001 ~ METER-004` | [表务详细设计](./01_Detailed_Design.md#sec-meter-detail) | [数据库设计](../03_Technical_Design/01_Database_Design.md)、[接口设计](../03_Technical_Design/03_Interface_Design.md) |
|
||||
| 报装与签章 | `INST-001 ~ INST-005` | [报装与签章详细设计](./01_Detailed_Design.md#sec-installation-detail) | [CA 补充说明](./03_CA_Esignature_Supplement.md)、[安全设计](../03_Technical_Design/04_Security_Design.md) |
|
||||
|
||||
<a id="sec-module-matrix"></a>
|
||||
|
||||
## 模块级追溯矩阵
|
||||
|
||||
| 模块编号 | 模块名称 | 主详设定位 | 关键数据域(摘要) | 关键接口编号(摘要) | 主要协同对象 |
|
||||
|---|---|---|---|---|---|
|
||||
| `UP-001` | 统一认证与单点登录 | [章节](./01_Detailed_Design.md#up-001-统一认证与单点登录) | 用户、令牌、登录日志 | `IF-UP-001`、`IF-UP-002` | 各接入端、统一平台 |
|
||||
| `UP-002` | 组织用户与权限管理 | [章节](./01_Detailed_Design.md#up-002-组织用户与权限管理) | 组织、岗位、角色、权限 | `IF-UP-003` | 各业务模块 |
|
||||
| `UP-003` | 参数字典与基础配置 | [章节](./01_Detailed_Design.md#up-003-参数字典与基础配置) | 字典、价格、地址、任务参数 | `IF-UP-004` | 营收、表务、报装 |
|
||||
| `UP-004` | 审计监控与运维支撑 | [章节](./01_Detailed_Design.md#up-004-审计监控与运维支撑) | 操作日志、接口日志、任务日志 | `IF-UP-003`(审计关联) | 运维平台、消息服务 |
|
||||
| `REV-001` | 客户资料管理 | [章节](./01_Detailed_Design.md#rev-001-客户资料管理) | 客户、账户、联系人、绑定关系 | `IF-REV-001` | 客户服务、表务、报装 |
|
||||
| `REV-002` | 抄表开账 | [章节](./01_Detailed_Design.md#rev-002-抄表开账) | 抄表任务、读数、账单主明细 | `IF-REV-004`、`IF-REV-005` | 抄表APP、IoT、表务 |
|
||||
| `REV-003` | 营业收费 | [章节](./01_Detailed_Design.md#rev-003-营业收费) | 营业账、交易流水、回调记录 | `IF-REV-006` | `SYS-009` 支付结算 |
|
||||
| `REV-004` | 账务处理 | [章节](./01_Detailed_Design.md#rev-004-账务处理) | 账单调整、日志、审批留痕 | `IF-REV-007` | 财务、营收后台 |
|
||||
| `REV-005` | 发票与税务处理 | [章节](./01_Detailed_Design.md#rev-005-发票与税务处理) | 发票主记录、税率、开票信息 | `IF-REV-008` | `SYS-008` 发票服务 |
|
||||
| `REV-006` | 催缴与通知 | [章节](./01_Detailed_Design.md#rev-006-催缴与通知) | 欠费账单、催缴结果 | `IF-REV-009` | `SYS-010` 消息服务 |
|
||||
| `REV-007` | 统计分析 | [章节](./01_Detailed_Design.md#rev-007-统计分析) | 客户、抄表、收费、渠道聚合 | `IF-REV-010` | 报表与管理端 |
|
||||
| `REV-008` | 代收与银行业务 | [章节](./01_Detailed_Design.md#rev-008-代收与银行业务) | 渠道、签约、批次、对账、结算 | `IF-REV-011` | 银行、`SYS-009` |
|
||||
| `REV-009` | 业务参数配置 | [章节](./01_Detailed_Design.md#rev-009-业务参数配置) | 参数配置、页面配置、价格模板 | `IF-REV-012` | 统一平台、营收模块 |
|
||||
| `CS-001` | 账户绑定管理 | [章节](./01_Detailed_Design.md#cs-001-账户绑定管理) | 渠道绑定、客户账户 | `IF-CS-001` | 微信、支付宝、微网厅 |
|
||||
| `CS-002` | 信息查询服务 | [章节](./01_Detailed_Design.md#cs-002-信息查询服务) | 账单、缴费、发票、流水 | `IF-CS-002` | 客户渠道、营收系统 |
|
||||
| `CS-003` | 在线缴费服务 | [章节](./01_Detailed_Design.md#cs-003-在线缴费服务) | 订单、交易、回调 | `IF-CS-003` | `SYS-009` 支付结算 |
|
||||
| `CS-004` | 电子发票服务 | [章节](./01_Detailed_Design.md#cs-004-电子发票服务) | 发票申请、税率、下载记录 | `IF-CS-004` | `SYS-008` 发票服务 |
|
||||
| `CS-005` | 营业网点服务 | [章节](./01_Detailed_Design.md#cs-005-营业网点服务) | 网点信息、业务范围 | `IF-CS-005` | 客户渠道 |
|
||||
| `CS-006` | 业务办理服务 | [章节](./01_Detailed_Design.md#cs-006-业务办理服务) | 办理申请、办理状态 | `IF-CS-006` | 工单系统、消息服务 |
|
||||
| `CS-007` | 柜面扫码支付 | [章节](./01_Detailed_Design.md#cs-007-柜面扫码支付) | 柜面订单、流水、核销状态 | `IF-CS-007` | 营业厅、`SYS-009` |
|
||||
| `METER-001` | 表务基础管理 | [章节](./01_Detailed_Design.md#meter-001-表务基础管理) | 水表档案、状态、参数 | `IF-METER-001` | 营收、报装 |
|
||||
| `METER-002` | 表务工单管理 | [章节](./01_Detailed_Design.md#meter-002-表务工单管理) | 换表/移表工单、处理结果 | `IF-METER-002` | 工单系统、移动作业 |
|
||||
| `METER-003` | 仓储与生命周期管理 | [章节](./01_Detailed_Design.md#meter-003-仓储与生命周期管理) | 库存、出入库、报废 | `IF-METER-003` | 仓储管理端 |
|
||||
| `METER-004` | 物联网接入与数据同步 | [章节](./01_Detailed_Design.md#meter-004-物联网接入与数据同步) | 远程抄表数据、异常告警 | `IF-METER-004` | IoT 平台、营收开账 |
|
||||
| `INST-001` | 报装申请与受理 | [章节](./01_Detailed_Design.md#inst-001-报装申请与受理) | 申请单、资料附件 | `IF-INST-001` | 柜台、微网厅、政务 |
|
||||
| `INST-002` | 现场踏勘与方案设计 | [章节](./01_Detailed_Design.md#inst-002-现场踏勘与方案设计) | 踏勘记录、方案版本 | `IF-INST-002` | 报装人员 |
|
||||
| `INST-003` | 施工验收与立户通水 | [章节](./01_Detailed_Design.md#inst-003-施工验收与立户通水) | 施工节点、验收结果 | `IF-INST-005`(归档协同) | 表务、客户建档 |
|
||||
| `INST-004` | 合同签署与电子签章 | [章节](./01_Detailed_Design.md#inst-004-合同签署与电子签章) | 合同、签章、存证 | `IF-INST-003`、`IF-INST-004` | 泛微 CA |
|
||||
| `INST-005` | 档案归档与过程留痕 | [章节](./01_Detailed_Design.md#inst-005-档案归档与过程留痕) | 档案、回执、过程日志 | `IF-INST-005` | 报装、档案管理 |
|
||||
|
||||
<a id="sec-maintenance"></a>
|
||||
|
||||
## 维护机制
|
||||
|
||||
更新本索引时遵循以下顺序:
|
||||
|
||||
1. 先更新 `01_Detailed_Design.md` 中模块主内容;
|
||||
2. 再同步本索引中的“模块定位/接口编号/数据域摘要”;
|
||||
3. 如涉及接口变化,同步更新 `03_Technical_Design/03_Interface_Design.md`;
|
||||
4. 完成后至少执行:
|
||||
- `make validate-file FILE=docs/design/02_Detailed_Design/01_Detailed_Design.md`
|
||||
- `make validate-file FILE=docs/design/02_Detailed_Design/02_Module_Traceability_Index.md`
|
||||
- `make check-links`
|
||||
|
||||
172
docs/design/02_Detailed_Design/03_CA_Esignature_Supplement.md
Normal file
172
docs/design/02_Detailed_Design/03_CA_Esignature_Supplement.md
Normal file
@ -0,0 +1,172 @@
|
||||
---
|
||||
doc_id: DT-03-CA-SUP
|
||||
doc_role: support_document
|
||||
authority: secondary
|
||||
scope: 报装电子签章专项补充
|
||||
source_of_truth: false
|
||||
last_reviewed: 2026-03-11
|
||||
retrieval_priority: P1
|
||||
---
|
||||
|
||||
# 福建水务营收系统报装电子签章设计补充说明
|
||||
|
||||
## 章节导航(精简)
|
||||
|
||||
- [文档定位与边界](#sec-position)
|
||||
- [集成架构与交互边界](#sec-architecture)
|
||||
- [接口清单与字段约定](#sec-interface)
|
||||
- [流程约束与状态管理](#sec-process)
|
||||
- [异常补偿与重试机制](#sec-retry)
|
||||
- [安全与合规控制](#sec-security)
|
||||
- [运维监控与发布管理](#sec-ops)
|
||||
|
||||
<a id="sec-position"></a>
|
||||
|
||||
## 文档定位与边界
|
||||
|
||||
本文件是 `01_Detailed_Design.md` 中 “`INST-004 合同签署与电子签章`” 的专项补充文档,重点补充:
|
||||
|
||||
1. 泛微 CA 接口对接边界与字段约定;
|
||||
2. 签章任务状态流转、异常补偿和运维观测点;
|
||||
3. 合规与审计约束落地要求。
|
||||
|
||||
权威边界:
|
||||
|
||||
- 报装业务主流程以 `01_Detailed_Design.md` 为准;
|
||||
- CA 方案总览可参考 `../04_Appendix/03_CA_Integration_Summary.md`;
|
||||
- 安全控制通用要求以 `../03_Technical_Design/04_Security_Design.md` 为准。
|
||||
|
||||
<a id="sec-architecture"></a>
|
||||
|
||||
## 集成架构与交互边界
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
subgraph INST[报装业务系统]
|
||||
A[合同管理]
|
||||
B[签章任务中心]
|
||||
C[回执处理]
|
||||
D[档案归档]
|
||||
end
|
||||
|
||||
subgraph CA[泛微 CA 电子签章平台]
|
||||
E[身份认证接口]
|
||||
F[签章接口]
|
||||
G[时间戳接口]
|
||||
H[存证接口]
|
||||
end
|
||||
|
||||
A --> B
|
||||
B --> E
|
||||
B --> F
|
||||
B --> G
|
||||
B --> H
|
||||
F --> C
|
||||
G --> C
|
||||
H --> C
|
||||
C --> D
|
||||
```
|
||||
|
||||
边界说明:
|
||||
|
||||
- 报装系统负责合同上下文、签署方信息、业务状态回写与档案归档;
|
||||
- 泛微 CA 负责身份认证、签章执行、时间戳与存证;
|
||||
- 回执成功后才允许进入“归档完成”状态。
|
||||
|
||||
<a id="sec-interface"></a>
|
||||
|
||||
## 接口清单与字段约定
|
||||
|
||||
### 1. 接口清单
|
||||
|
||||
| 接口方向 | 业务接口编号 | 对接接口名称 | 关键输入 | 关键输出 |
|
||||
|---|---|---|---|---|
|
||||
| 报装系统 → CA | `IF-INST-003` | 合同签署发起 | 合同ID、签署方、签署位置、业务流水号 | 签章任务ID、受理状态 |
|
||||
| 报装系统 → CA | `IF-INST-003` | 身份认证调用 | 用户标识、认证类型、认证要素 | 认证结果、认证凭证 |
|
||||
| 报装系统 → CA | `IF-INST-003` | 时间戳申请 | 签章摘要哈希、请求时间 | 时间戳令牌、签发时间 |
|
||||
| 报装系统 → CA | `IF-INST-003` | 存证申请 | 签章后文档摘要、元数据 | 存证ID、存证状态 |
|
||||
| CA → 报装系统 | `IF-INST-004` | 签章结果回执 | 任务ID、签章状态、凭证编号、失败原因 | 回写结果、重试标记 |
|
||||
|
||||
### 2. 字段约定(最小集)
|
||||
|
||||
| 字段 | 说明 | 约束 |
|
||||
|---|---|---|
|
||||
| `biz_trace_id` | 业务追踪ID | 必填;同一签署流程全链路唯一 |
|
||||
| `contract_id` | 合同ID | 必填;与报装申请单关联 |
|
||||
| `sign_task_id` | 签章任务ID | 回执必填;用于幂等去重 |
|
||||
| `sign_status` | 签署状态 | 必填;`INIT/PROCESSING/SUCCESS/FAILED` |
|
||||
| `evidence_id` | 存证ID | 成功场景必填 |
|
||||
| `error_code` | 异常码 | 失败场景必填 |
|
||||
| `error_message` | 异常描述 | 失败场景必填;可审计 |
|
||||
| `callback_time` | 回执时间 | 必填;用于超时判断 |
|
||||
|
||||
<a id="sec-process"></a>
|
||||
|
||||
## 流程约束与状态管理
|
||||
|
||||
### 1. 签章状态机
|
||||
|
||||
```mermaid
|
||||
stateDiagram-v2
|
||||
[*] --> INIT
|
||||
INIT --> PROCESSING: 发起签署
|
||||
PROCESSING --> SUCCESS: 回执成功
|
||||
PROCESSING --> FAILED: 回执失败
|
||||
FAILED --> PROCESSING: 人工重试/系统重试
|
||||
SUCCESS --> ARCHIVED: 完成归档
|
||||
ARCHIVED --> [*]
|
||||
```
|
||||
|
||||
### 2. 关键约束
|
||||
|
||||
1. 签章发起前必须完成合同正文固化与版本锁定;
|
||||
2. 同一 `sign_task_id` 回执必须幂等处理,禁止重复更新业务状态;
|
||||
3. 失败回执需记录错误码并进入补偿队列,不允许静默丢失;
|
||||
4. 归档完成前,合同状态不得标记为“签署完成可生效”。
|
||||
|
||||
<a id="sec-retry"></a>
|
||||
|
||||
## 异常补偿与重试机制
|
||||
|
||||
| 异常类型 | 检测方式 | 处理策略 | 人工介入条件 |
|
||||
|---|---|---|---|
|
||||
| 网络超时 | 请求超时/连接异常 | 指数退避重试(最多3次) | 连续失败或超时超过阈值 |
|
||||
| CA受理失败 | 返回失败码 | 写入补偿队列并通知业务端 | 失败码为不可恢复类 |
|
||||
| 回执丢失 | 超时未回执 | 主动查询 + 重放回执校验 | 超过最大等待窗口 |
|
||||
| 数据校验失败 | 字段缺失/签名不匹配 | 拒绝入库并告警 | 连续出现同类异常 |
|
||||
|
||||
补偿要求:
|
||||
|
||||
- 所有补偿任务必须带 `biz_trace_id`;
|
||||
- 重试与人工补录均写入审计日志;
|
||||
- 重试成功后需自动回补主流程状态。
|
||||
|
||||
<a id="sec-security"></a>
|
||||
|
||||
## 安全与合规控制
|
||||
|
||||
1. 传输安全:CA 对接链路统一使用 HTTPS,回执启用签名校验;
|
||||
2. 身份安全:签署方认证结果需与报装业务实名信息一致;
|
||||
3. 数据安全:合同摘要、签章凭证、存证编号需防篡改存储;
|
||||
4. 审计留痕:签章发起、回执处理、补偿重试、人工干预均需审计;
|
||||
5. 合规要求:执行《电子签名法》及项目安全设计文档中关于日志留痕、访问控制和数据保护要求。
|
||||
|
||||
<a id="sec-ops"></a>
|
||||
|
||||
## 运维监控与发布管理
|
||||
|
||||
### 1. 监控指标
|
||||
|
||||
| 指标 | 说明 | 建议阈值 |
|
||||
|---|---|---|
|
||||
| 签章成功率 | 成功任务 / 总任务 | 日均 ≥ 99% |
|
||||
| 回执时延P95 | 发起到回执耗时 | ≤ 5 秒 |
|
||||
| 补偿队列积压 | 待补偿任务数 | 告警阈值按租户配置 |
|
||||
| 幂等冲突次数 | 重复回执冲突数 | 连续异常触发告警 |
|
||||
|
||||
### 2. 发布与变更
|
||||
|
||||
1. 涉及 CA 字段或签名算法变更,需先更新本补充文档与接口设计文档;
|
||||
2. 发布前执行联调清单:签署成功、签署失败、回执重放、超时补偿;
|
||||
3. 发布后至少观察一个完整业务周期,确认签章成功率与回执时延稳定。
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# 02_Detailed 详细设计入口
|
||||
# 02_Detailed_Design 详细设计入口
|
||||
|
||||
## 目录用途
|
||||
|
||||
@ -10,12 +10,12 @@
|
||||
|
||||
## 关联文档
|
||||
|
||||
- `02_Module_Design.md`:模块设计补充
|
||||
- `03_CA_Installation_Design.md`:报装 CA 集成设计
|
||||
- `02_Module_Traceability_Index.md`:模块追溯索引(模块-接口-数据域快速定位)
|
||||
- `03_CA_Esignature_Supplement.md`:报装 CA 电子签章专项补充
|
||||
|
||||
## 维护原则
|
||||
|
||||
- 详细设计应与概要设计、数据库设计、接口设计保持一致
|
||||
- 高风险变更(模块拆分、编号体系、流程调整)需先评估影响面
|
||||
- 变更后需同步更新任务台账与进度记录
|
||||
|
||||
- 历史并行稿已迁入 `docs/design/04_Appendix/Archive/03_Design_Docs/`
|
||||
|
||||
@ -386,7 +386,7 @@ sequenceDiagram
|
||||
|
||||
### 12.3 相关设计文档
|
||||
|
||||
1. [报装业务系统电子签章功能设计](../02_Detailed/03_CA_Installation_Design.md)
|
||||
1. [报装业务系统电子签章专项补充](../02_Detailed_Design/03_CA_Esignature_Supplement.md)
|
||||
2. [报装业务系统电子签章数据库设计](02_Database_Design_CA.md)
|
||||
3. [报装业务系统电子签章集成概要设计](01_Overview_CA.md)
|
||||
|
||||
@ -395,4 +395,3 @@ sequenceDiagram
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -587,8 +587,8 @@ process_single_document() {
|
||||
"02_System_Architecture")
|
||||
doc_title="福建水务营收系统-系统架构设计"
|
||||
;;
|
||||
"02_Module_Design")
|
||||
doc_title="福建水务营收系统-模块功能设计"
|
||||
"02_Module_Traceability_Index")
|
||||
doc_title="福建水务营收系统-模块追溯索引"
|
||||
;;
|
||||
"01_Database_Design")
|
||||
doc_title="福建水务营收系统-数据库设计"
|
||||
@ -617,8 +617,8 @@ process_single_document() {
|
||||
"06_Sensitive_Data_Encryption")
|
||||
doc_title="福建水务营收系统-敏感数据加密方案"
|
||||
;;
|
||||
"03_CA_Installation_Design")
|
||||
doc_title="福建水务营收系统-报装CA集成设计"
|
||||
"03_CA_Esignature_Supplement")
|
||||
doc_title="福建水务营收系统-报装CA电子签章补充"
|
||||
;;
|
||||
*)
|
||||
doc_title="福建水务营收系统-$doc_name"
|
||||
@ -672,8 +672,8 @@ main() {
|
||||
"docs/design/01_Overview/02_System_Architecture.md"
|
||||
"docs/design/01_Overview/03_Summary_Design.md"
|
||||
"docs/design/02_Detailed_Design/01_Detailed_Design.md"
|
||||
"docs/design/02_Detailed_Design/02_Module_Design.md"
|
||||
"docs/design/02_Detailed_Design/03_CA_Installation_Design.md"
|
||||
"docs/design/02_Detailed_Design/02_Module_Traceability_Index.md"
|
||||
"docs/design/02_Detailed_Design/03_CA_Esignature_Supplement.md"
|
||||
"docs/design/03_Technical_Design/01_Database_Design.md"
|
||||
"docs/design/03_Technical_Design/02_Table_Specs.md"
|
||||
"docs/design/03_Technical_Design/03_Interface_Design.md"
|
||||
@ -756,4 +756,4 @@ case "${1:-}" in
|
||||
show_usage
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
esac
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user