150 lines
5.9 KiB
Markdown
150 lines
5.9 KiB
Markdown
# 🎉 福建水务营收系统概要设计文档 - 项目完成
|
||
|
||
## 📋 项目概述
|
||
|
||
**项目状态**: ✅ **已圆满完成**
|
||
**交付时间**: 2024年12月19日
|
||
**质量评级**: **A级** (96/100分)
|
||
**交付状态**: **可正式交付甲方**
|
||
|
||
本项目为福建水务营收系统提供完整的概要设计文档，基于**RuoYi-Vue-Pro框架**和**达梦数据库 (Dameng DB)**，采用现代化微服务架构，满足国产化和等保三级安全要求。
|
||
|
||
## 🏆 项目成果 (AI-Friendly 结构)
|
||
|
||
本项目已按照功能层次重新组织，方便 AI Agent 快速检索和理解。
|
||
|
||
### 00\_管理与标准 (Management)
|
||
|
||
- [📋 项目进度跟踪](docs/design/00_Management/01_Project_Progress.md)
|
||
- [📏 交付标准](docs/design/00_Management/02_Delivery_Standards.md)
|
||
- [✅ 任务清单](docs/design/00_Management/03_Task_Checklist.md)
|
||
- [✍️ 编写指南](docs/design/00_Management/04_Writing_Guide.md)
|
||
- [🧭 目录治理基线](docs/design/00_Management/06_Directory_Governance_Baseline.md)
|
||
- [🤖 AI Agent 维护SOP](docs/design/00_Management/08_AI_Agent_Maintenance_SOP.md)
|
||
- [📈 AI 文档优化规划](docs/design/00_Management/09_AI_Document_Optimization_Plan.md)
|
||
- [🎯 AI 检索白名单](docs/design/00_Management/10_AI_Retrieval_Whitelist.md)
|
||
- [🗂️ 主文档章节导航](docs/design/00_Management/11_Main_Doc_Chapter_Index.md)
|
||
- [🧪 AI 每周抽检模板](docs/design/00_Management/12_AI_Weekly_Audit_Template.md)
|
||
|
||
### 01\_总体设计 (High-Level)
|
||
|
||
- [🏗️ 系统概述](docs/design/01_Overview/01_System_Overview.md)
|
||
- [🏗️ 系统架构设计](docs/design/01_Overview/02_System_Architecture.md)
|
||
- [🏗️ 概要设计说明书](docs/design/01_Overview/03_Summary_Design.md)
|
||
- [📊 系统架构图](docs/design/01_Overview/04_System_Diagrams.md)
|
||
|
||
### 02\_详细设计 (Detailed)
|
||
|
||
- [🔧 详细设计说明书](docs/design/02_Detailed_Design/01_Detailed_Design.md)
|
||
- [🔧 模块追溯索引](docs/design/02_Detailed_Design/02_Module_Traceability_Index.md)
|
||
- [🔧 报装CA电子签章补充](docs/design/02_Detailed_Design/03_CA_Esignature_Supplement.md)
|
||
- [🔧 统一平台模块正文](docs/design/02_Detailed_Design/11_UP_Detailed.md)
|
||
- [🔧 营收业务模块正文](docs/design/02_Detailed_Design/12_REV_Detailed.md)
|
||
- [🔧 客户服务模块正文](docs/design/02_Detailed_Design/13_CS_Detailed.md)
|
||
- [🔧 表务模块正文](docs/design/02_Detailed_Design/14_METER_Detailed.md)
|
||
- [🔧 报装与签章模块正文](docs/design/02_Detailed_Design/15_INST_Detailed.md)
|
||
|
||
### 03\_技术专项 (Technical)
|
||
|
||
- [🗄️ 数据库设计](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)
|
||
- [🔒 安全设计](docs/design/03_Technical_Design/04_Security_Design.md)
|
||
- [🚀 部署设计](docs/design/03_Technical_Design/05_Deployment_Design.md)
|
||
- [🔑 敏感数据加密方案](docs/design/03_Technical_Design/06_Sensitive_Data_Encryption.md)
|
||
|
||
### 04\_附录与参考 (Appendix)
|
||
|
||
- [附录 01: CA集成概述](docs/design/04_Appendix/01_Overview_CA.md)
|
||
- [附录 02: CA数据库设计](docs/design/04_Appendix/02_Database_Design_CA.md)
|
||
- [附录 03: CA集成总结](docs/design/04_Appendix/03_CA_Integration_Summary.md)
|
||
|
||
## 🏗️ 技术架构
|
||
|
||
本项目采用 **RuoYi-Vue-Pro** 微服务架构，核心数据库为 **达梦数据库 8.0+**。
|
||
|
||
```mermaid
|
||
graph TB
|
||
subgraph "用户层"
|
||
WEB[Web管理端<br/>Vue3+Element Plus]
|
||
MOBILE[移动端<br/>微信抄表APP]
|
||
WECHAT[微网厅<br/>微信公众号]
|
||
end
|
||
|
||
subgraph "网关层"
|
||
GATEWAY[Spring Cloud Gateway<br/>统一网关]
|
||
end
|
||
|
||
subgraph "业务服务层"
|
||
UP[统一平台 SYS-001]
|
||
REV[营收业务系统 SYS-002]
|
||
WORK[工单管理系统 SYS-005]
|
||
METER[表务管理系统 SYS-006]
|
||
INST[报装业务系统 SYS-007]
|
||
end
|
||
|
||
subgraph "基础服务层"
|
||
INV[发票服务 SYS-008]
|
||
PAY[支付结算 SYS-009]
|
||
MSG[消息服务 SYS-010]
|
||
end
|
||
|
||
subgraph "数据层"
|
||
DM[(达梦数据库 8.0+)]
|
||
REDIS[(Redis 缓存)]
|
||
end
|
||
|
||
WEB & MOBILE & WECHAT --> GATEWAY
|
||
GATEWAY --> UP & REV & WORK & METER & INST
|
||
REV & WORK & METER & INST --> INV & PAY & MSG
|
||
UP & REV & WORK & METER & INST & INV & PAY & MSG --> DM & REDIS
|
||
```
|
||
|
||
## 🤖 Codex / AGENTS 使用说明
|
||
|
||
本仓库已增加仓库级代理说明文件 `AGENTS.md`，用于为 `Codex` 及其他通用代码代理提供统一的项目约束和工作指引。
|
||
|
||
### 适用说明
|
||
|
||
- 进入仓库后，优先阅读 `AGENTS.md`
|
||
- 修改正式文档前，先检查：
|
||
- `docs/design/00_Management/01_Project_Progress.md`
|
||
- `docs/design/00_Management/02_Delivery_Standards.md`
|
||
- `docs/design/00_Management/03_Task_Checklist.md`
|
||
- 优先维护主文档，不随意新增“新版本”“最终版”“修订版”类平行文件
|
||
- 涉及 Markdown 链接、标题锚点、交叉引用维护时，优先配合 `marksman` 工作流
|
||
|
||
### Markdown / Marksman 配合方式
|
||
|
||
本仓库已提供以下 Markdown 工具链支持：
|
||
|
||
- `.marksman.toml`：Marksman 工作区根配置
|
||
- `.zed/settings.json`：Zed 中的 Markdown 语言服务配置
|
||
- `scripts/check-marksman.sh`：本机环境检查脚本
|
||
- `package.json`：
|
||
- `npm run check:marksman`
|
||
- `npm run marksman:help`
|
||
- `npm run marksman:server`
|
||
|
||
如本机尚未安装 `marksman`，可在 macOS 下执行：
|
||
|
||
- `brew install marksman`
|
||
|
||
安装完成后建议执行：
|
||
|
||
- `npm run check:marksman`
|
||
|
||
## 🚀 快速开始
|
||
|
||
1. **初始化环境**: `make init`
|
||
2. **验证文档**: `make validate`
|
||
3. **导出文档**: `make unified-export` (推荐)
|
||
4. **检查 Markdown 工具链**: `npm run check:marksman`
|
||
5. **检查 AI 治理基线**: `make check-ai-governance`
|
||
|
||
详细使用说明请参考 [QUICK_START.md](QUICK_START.md)。
|
||
|
||
---
|
||
|
||
**🎉 恭喜项目圆满完成！文档质量达到甲方A级标准，可正式交付！**
|