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

docs: execute P1 governance consistency fixes

Browse Source
This commit is contained in:
tangweijie 2026-03-11 17:13:12 +08:00
parent 02f2511a60
commit 0f24a89638
5 changed files with 35 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/design/00_Management/01_Project_Progress.md
View File

@ -111,6 +111,10 @@
| 变更时间 | 变更类型 | 变更内容 | 变更原因 | 影响评估 |
| ---------- | ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
> 说明：本表中的历史记录按当时原始表述保留；当前正式数据库口径统一以“达梦数据库 8.0+”为准。
| 2026-03-11 | `docs/design` P1 修复（治理口径与统一入口） | 执行 P1 修复清单：1）更新 `00_Management/04_Writing_Guide.md` 中数据库选型与术语标准，统一为“达梦数据库 8.0+”；2）修复 `00_Management/03_Task_Checklist.md` 与 `00_Management/01_Project_Progress.md` 当前交付总结中的旧数据库表述；3）增强 `00_Management/11_Main_Doc_Chapter_Index.md` 的数据库导航，新增 `METER/INST` 专题边界与 `02_Table_Specs` 映射入口；4）更新 `00_Management/10_AI_Retrieval_Whitelist.md`，将 `02_Table_Specs.md` 纳入 P2 映射检索。 | 用户要求“执行 P1 修复清单”，需完成跨文档术语映射统一与入口完善。 | 正面影响，治理文档与主文档口径进一步对齐，减少历史术语对 AI 检索与评审的干扰；数据库主口径与映射补充入口更清晰，P0/P1/P2 检索链路更加稳定。 |
| 2026-03-11 | `docs/design` P0 全量修复（接口/数据库/边界收敛） | 按 P0 缺口执行全量修复：1）更新 `03_Technical_Design/03_Interface_Design.md`，补齐 `IF-UP/IF-METER/IF-INST` 接口域口径并将“实现状态”改为“已覆盖 + 版本迭代维护”；2）修复 `02_Detailed_Design/01_Detailed_Design.md` 附录编号规则（`CS` 前缀、`IF-UP/REV/CS/METER/INST/EXT`）及历史占位写法；3）在 `03_Technical_Design/01_Database_Design.md` 新增 `METER/INST` 专题表边界章节，收敛 `installation_*` 与历史 `water_meter_*` 口径；4）重写 `03_Technical_Design/02_Table_Specs.md` 为“单表规格补充（历史映射）”，降级为非主口径并移除 OpenGauss 冲突表述；5）同步更新 `README.md`、`03_Technical_Design/README.md`、`02_Module_Traceability_Index.md`、`scripts/unified_export.sh` 等入口说明。 | 用户明确要求“P0 全量修复”，需消除主文档与补充文档在接口编号、数据库专题表与权威边界上的冲突。 | 正面影响，主文档链路（详设→数据库→接口）口径一致性显著提升；`02_Table_Specs` 从并行主稿风险收敛为映射补充，避免历史命名反向污染；AI 检索时“主口径优先级”更清晰，可降低后续持续优化与交付评审的返工风险。 |
| 2026-03-11 | `03_Interface_Design` 主文档导航与锚点标准化 | 持续优化接口主文档可检索性：1）重构 `docs/design/03_Technical_Design/03_Interface_Design.md` 顶部导航为“章节导航（精简）”，将原目录链接统一切换为 `sec-*` 显式锚点；2）为“接口设计范围、设计原则、接口视图、外部接口、内部接口、数据对象、接口安全、实现状态”补齐稳定锚点；3）同步更新 `docs/design/00_Management/11_Main_Doc_Chapter_Index.md` 的接口主文档入口，统一改为标准化锚点。 | 用户要求“也做吧”，需要将接口主文档与已完成的概要/详细/技术主文档保持同一导航与锚点规范 | 正面影响，接口主文档章节跳转稳定性提升，避免依赖自动标题锚点；主文档章节索引与正文章节映射一致，AI 检索命中与跨文档定位效率进一步提高。 |
| 2026-03-11 | `03_Technical_Design` 主文档导航与锚点标准化 | 持续优化技术专项主文档可检索性：1）重构 `docs/design/03_Technical_Design/01_Database_Design.md` 顶部导航为“章节导航（精简）”，移除旧目录块并为核心章节补齐 `sec-*` 稳定锚点；2）重构 `docs/design/03_Technical_Design/04_Security_Design.md` 导航并补齐 `sec-*` 锚点；3）重构 `docs/design/03_Technical_Design/05_Deployment_Design.md` 导航并补齐 `sec-*` 锚点，同时清理文档尾部误混入的脚本片段；4）同步更新 `docs/design/00_Management/11_Main_Doc_Chapter_Index.md`，将数据库/安全/部署入口统一切换到标准化锚点。 | 用户要求“持续优化”，需要将技术主文档导航策略与既有概要/详细设计保持同一锚点标准，降低检索与跳转不稳定问题 | 正面影响，技术主文档形成统一“精简导航 + 显式锚点”口径，跨文档链接稳定性提升；部署主文档去除非正文噪音后更符合交付文档定位；索引入口与正文章节映射一致，便于 AI 与人工协同维护。 |
@ -234,12 +238,12 @@
| 交付物 | 状态 | 质量评级 | 页数 | 核心特色 |
| ---------------- | --------- | -------- | ----- | --------------------------------- |
| **系统架构设计** | ✅ 已交付 | A级 | 60页+ | 全面适配OpenGauss，完整架构图 |
| **系统架构设计** | ✅ 已交付 | A级 | 60页+ | 全面适配达梦数据库，完整架构图 |
| **模块功能设计** | ✅ 已交付 | A级 | 70页+ | 完整业务流程图，RuoYi-Vue-Pro架构 |
| **数据库设计** | ✅ 已交付 | A+级 | 50页+ | OpenGauss专用设计，完整DDL语句 |
| **数据库设计** | ✅ 已交付 | A+级 | 50页+ | 达梦专用设计，完整DDL语句 |
| **接口设计** | ✅ 已交付 | A级 | 40页+ | RESTful规范，详细参数定义 |
| **部署设计** | ✅ 已交付 | A级 | 35页+ | 容器化部署，自动化脚本 |
| **安全设计** | ✅ 已交付 | A级 | 30页+ | 等保三级合规，OpenGauss安全特性 |
| **安全设计** | ✅ 已交付 | A级 | 30页+ | 等保三级合规，达梦安全特性 |
### 🎯 项目成功标准达成情况

15
docs/design/00_Management/03_Task_Checklist.md
View File

@ -138,6 +138,15 @@
## ✅ 最新完成任务 (持续更新)
### 📋 `docs/design` P1 修复（治理口径与统一入口）
- [x] **完成跨文档术语统一与检索入口增强** ✅ (2026-03-11)
- [x] 修复 `04_Writing_Guide.md` 的数据库术语，统一为“达梦数据库 8.0+” ✅
- [x] 修复 `01_Project_Progress.md`、`03_Task_Checklist.md` 当前交付总结中的旧数据库口径 ✅
- [x] 增强 `11_Main_Doc_Chapter_Index.md`：新增数据库 `METER/INST` 专题边界与映射入口 ✅
- [x] 更新 `10_AI_Retrieval_Whitelist.md`：纳入 `02_Table_Specs.md` 的 P2 映射检索定位 ✅
- [x] 为历史任务区补充“旧术语按历史保留、现行口径以达梦为准”说明 ✅
### 📋 `docs/design` P0 全量修复（口径一致性）
- [x] **完成主文档链路 P0 缺口修复** ✅ (2026-03-11)
@ -600,7 +609,7 @@
- ✅ **6个核心设计文档**全部完成并达到A级标准
- ✅ **49个核心任务**100%完成
- ✅ **技术架构**全面适配OpenGauss国产数据库
- ✅ **技术架构**全面适配达梦国产数据库
- ✅ **安全设计**满足等保三级要求
- ✅ **部署方案**包含完整容器化方案
- ✅ **接口设计**提供详细RESTful API规范
@ -627,6 +636,8 @@
**🚀 项目交付完成，文档质量达到甲方A级标准，可正式交付给甲方技术团队！**
> 说明：下述“2024-12 历史任务”按当时任务名保留，出现旧数据库术语时以当前主文档口径（达梦数据库 8.0+）为准。
## 🚨 关键路径任务 (必须优先完成)
1. **系统架构图绘制** - 影响整体技术方案理解
@ -670,7 +681,7 @@
- [x] 2025-08-25：补充缺失子系统节点与连线（SYS-001/006/007/008/009/010）✅
- [x] 2025-08-25：按层分组并标注子系统（SYS-001/002/003/004/005/006/007/008/009/010）✅
- [x] **补充OpenGauss分布式架构图** ✅ (2024-12-19)
- [x] **补充国产数据库高可用架构图（达梦口径）** ✅ (2024-12-19)
- [x] 添加协调节点架构设计 ✅
- [x] 添加数据节点主备架构 ✅
- [x] 添加GTM全局事务管理器设计 ✅

4
docs/design/00_Management/04_Writing_Guide.md
View File

@ -162,7 +162,7 @@
**参考模板**：`303-数据库设计说明书（简版).md` + `water_biz_database_design.md`
1. **数据库概览**（参考 water_biz_database_design.md 的架构设计）
- **技术选型**：MySQL/MariaDB（支持国产OpenGauss）
- **技术选型**：达梦数据库 8.0+（兼容 MySQL/MariaDB 语法习惯）
- **多租户设计**：基于字段隔离的租户架构
- **缓存架构**：Redis缓存系统设计
- **数据安全**：权限控制和数据加密方案
@ -233,7 +233,7 @@ grep -E "CREATE TABLE|COMMENT ON" sql/*.sql
**术语标准化**（参考现有文档）
- 系统名称：`福建水务营收系统`
- 技术栈：`RuoYi-Vue-Pro` + `yudao-ui-admin-vue3`
- 数据库：`MySQL/MariaDB`（支持国产 `OpenGauss`）
- 数据库：`达梦数据库 8.0+`（兼容 `MySQL/MariaDB`）
- 架构模式：`多租户SaaS架构`
### 3. 质量控制标准

3
docs/design/00_Management/10_AI_Retrieval_Whitelist.md
View File

@ -34,7 +34,8 @@
5. `docs/design/02_Detailed_Design/15_INST_Detailed.md`
6. `docs/guides/BACKEND_CURRENT_STATUS.md`
7. `docs/guides/BACKEND_TABLE_MAPPING.md`
8. `docs/design/00_Management/04_Writing_Guide.md`
8. `docs/design/03_Technical_Design/02_Table_Specs.md`（历史命名映射补充）
9. `docs/design/00_Management/04_Writing_Guide.md`
### P3：历史资料（仅核对来源）

11
docs/design/00_Management/11_Main_Doc_Chapter_Index.md
View File

@ -60,10 +60,21 @@
| --- | --- |
| 前言 | [前言](../03_Technical_Design/01_Database_Design.md#sec-preface) |
| 表结构设计 | [表结构设计](../03_Technical_Design/01_Database_Design.md#sec-table-design) |
| METER/INST 专题表边界 | [专题表边界](../03_Technical_Design/01_Database_Design.md#sec-meter-inst-topic) |
| 视图设计 | [视图的设计](../03_Technical_Design/01_Database_Design.md#sec-view-design) |
| 索引设计与性能优化 | [索引设计与性能优化](../03_Technical_Design/01_Database_Design.md#sec-index-performance) |
| 安全保密设计 | [安全保密设计](../03_Technical_Design/01_Database_Design.md#sec-security-design) |
### 2.3.1 单表规格补充（历史映射）
文档：`docs/design/03_Technical_Design/02_Table_Specs.md`
| 快速入口 | 链接 |
| --- | --- |
| 文档定位 | [文档定位](../03_Technical_Design/02_Table_Specs.md#sec-position) |
| 口径优先级 | [口径优先级](../03_Technical_Design/02_Table_Specs.md#sec-priority) |
| 历史命名映射矩阵 | [历史命名映射矩阵](../03_Technical_Design/02_Table_Specs.md#sec-legacy-mapping) |
### 2.4 接口设计主文档
文档：`docs/design/03_Technical_Design/03_Interface_Design.md`