chore(docs): migrate design directories into docs/design

This commit is contained in:
tangweijie 2026-03-11 14:37:49 +08:00
parent ae2a1c1110
commit 747de59934
6074 changed files with 252 additions and 231 deletions

View File

@ -19,11 +19,11 @@
```text
/
├── 00_Management/ # 项目管理、进度跟踪、交付规范、编写指南
├── 01_High_Level/ # 总体设计:系统概述、系统架构、概要设计、系统图谱
├── 02_Detailed/ # 详细设计主详设、模块设计、CA 安装设计
├── 03_Technical/ # 技术专项:数据库、表结构、接口、安全、部署、加密
├── 04_Appendix/ # 附录与归档资料
├── docs/design/00_Management/ # 项目管理、进度跟踪、交付规范、编写指南
├── docs/design/01_Overview/ # 总体设计:系统概述、系统架构、概要设计、系统图谱
├── docs/design/02_Detailed_Design/ # 详细设计主详设、模块设计、CA 安装设计
├── docs/design/03_Technical_Design/ # 技术专项:数据库、表结构、接口、安全、部署、加密
├── docs/design/04_Appendix/ # 附录与归档资料
├── .claude/ # Claude Code 相关配置
├── .omc/ # 项目记忆与代理状态
├── .zed/ # Zed 项目配置
@ -39,18 +39,18 @@
优先维护以下主文档,不要轻易再创建新的平行版本:
- `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`:部署设计主文档
- `docs/design/01_Overview/03_Summary_Design.md`:概要设计主文档
- `docs/design/02_Detailed_Design/01_Detailed_Design.md`:详细设计主文档
- `docs/design/03_Technical_Design/01_Database_Design.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`:部署设计主文档
如果已有主文档可以承载内容,**优先编辑现有文件,而不是新增“新-xxx”“最终版”“修订版”之类文件**。
### Archive 仅作归档
`04_Appendix/Archive/` 下的内容默认视为历史资料、原始附件、操作手册或数据字典来源:
`docs/design/04_Appendix/Archive/` 下的内容默认视为历史资料、原始附件、操作手册或数据字典来源:
- 可引用
- 可核对
@ -69,14 +69,14 @@
在修改任何正式文档前,优先查看:
1. `00_Management/01_Project_Progress.md`
2. `00_Management/02_Delivery_Standards.md`
3. `00_Management/03_Task_Checklist.md`
1. `docs/design/00_Management/01_Project_Progress.md`
2. `docs/design/00_Management/02_Delivery_Standards.md`
3. `docs/design/00_Management/03_Task_Checklist.md`
4. 与本次任务直接相关的目标文档
如果任务涉及结构性调整,还应同步查看:
- `00_Management/04_Writing_Guide.md`
- `docs/design/00_Management/04_Writing_Guide.md`
- `docs/guides/` 下相关说明
## 文档编写与修改规则
@ -93,7 +93,7 @@
所有修改必须优先对齐以下事实来源:
- 当前仓库中的正式设计文档
- `04_Appendix/Archive/` 中的需求、手册、历史设计、数据字典
- `docs/design/04_Appendix/Archive/` 中的需求、手册、历史设计、数据字典
- `docs/guides/BACKEND_CURRENT_STATUS.md`
- `docs/guides/BACKEND_TABLE_MAPPING.md`
- 用户在对话中明确给出的最新口径
@ -250,8 +250,8 @@ npm run marksman:server
1. 检查目标文档内容是否与上下文一致
2. 检查相关图表、目录、表格、交叉引用是否同步
3. 如属于正式文档的重要修改,更新 `00_Management/01_Project_Progress.md` 的变更记录
4. 如属于明确任务项完成,可同步更新 `00_Management/03_Task_Checklist.md`
3. 如属于正式文档的重要修改,更新 `docs/design/00_Management/01_Project_Progress.md` 的变更记录
4. 如属于明确任务项完成,可同步更新 `docs/design/00_Management/03_Task_Checklist.md`
## 对通用代码代理的具体要求

View File

@ -19,11 +19,11 @@
```text
/
├── 00_Management/ # 项目管理、进度跟踪、交付规范、编写指南
├── 01_High_Level/ # 总体设计:系统概述、系统架构、概要设计、系统图谱
├── 02_Detailed/ # 详细设计主详设、模块设计、CA 安装设计
├── 03_Technical/ # 技术专项:数据库、表结构、接口、安全、部署、加密
├── 04_Appendix/ # 附录与归档资料
├── docs/design/00_Management/ # 项目管理、进度跟踪、交付规范、编写指南
├── docs/design/01_Overview/ # 总体设计:系统概述、系统架构、概要设计、系统图谱
├── docs/design/02_Detailed_Design/ # 详细设计主详设、模块设计、CA 安装设计
├── docs/design/03_Technical_Design/ # 技术专项:数据库、表结构、接口、安全、部署、加密
├── docs/design/04_Appendix/ # 附录与归档资料
├── assets/ # 图片、模板等静态资源
├── docs/ # 研究资料、映射文档、使用指南
├── scripts/ # 文档处理与导出脚本
@ -36,18 +36,18 @@
优先维护以下主文档,不要轻易再创建新的平行版本:
- `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`:部署设计主文档
- `docs/design/01_Overview/03_Summary_Design.md`:概要设计主文档
- `docs/design/02_Detailed_Design/01_Detailed_Design.md`:详细设计主文档
- `docs/design/03_Technical_Design/01_Database_Design.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`:部署设计主文档
如果已有主文档可以承载内容,**优先编辑现有文件,而不是新增“新-xxx”“最终版”“修订版”之类文件**。
### 2. Archive 仅作归档
`04_Appendix/Archive/` 下的内容默认视为历史资料、原始附件、操作手册或数据字典来源:
`docs/design/04_Appendix/Archive/` 下的内容默认视为历史资料、原始附件、操作手册或数据字典来源:
- 可引用
- 可核对
@ -66,14 +66,14 @@
在修改任何正式文档前,优先查看:
1. `00_Management/01_Project_Progress.md`
2. `00_Management/02_Delivery_Standards.md`
3. `00_Management/03_Task_Checklist.md`
1. `docs/design/00_Management/01_Project_Progress.md`
2. `docs/design/00_Management/02_Delivery_Standards.md`
3. `docs/design/00_Management/03_Task_Checklist.md`
4. 与本次任务直接相关的目标文档
如果任务涉及结构性调整,还应同步查看:
- `00_Management/04_Writing_Guide.md`
- `docs/design/00_Management/04_Writing_Guide.md`
- `docs/guides/` 下相关说明
## 文档编写与修改规则
@ -90,7 +90,7 @@
所有修改必须优先对齐以下事实来源:
- 当前仓库中的正式设计文档
- `04_Appendix/Archive/` 中的需求、手册、历史设计、数据字典
- `docs/design/04_Appendix/Archive/` 中的需求、手册、历史设计、数据字典
- `docs/guides/BACKEND_CURRENT_STATUS.md`
- `docs/guides/BACKEND_TABLE_MAPPING.md`
- 用户在对话中明确给出的最新口径
@ -244,8 +244,8 @@ make unified-export
1. 检查目标文档内容是否与上下文一致
2. 检查相关图表、目录、表格、交叉引用是否同步
3. 如属于正式文档的重要修改,更新 `00_Management/01_Project_Progress.md` 的变更记录
4. 如属于明确任务项完成,可同步更新 `00_Management/03_Task_Checklist.md`
3. 如属于正式文档的重要修改,更新 `docs/design/00_Management/01_Project_Progress.md` 的变更记录
4. 如属于明确任务项完成,可同步更新 `docs/design/00_Management/03_Task_Checklist.md`
## 对 Claude Code 的具体要求

View File

@ -191,9 +191,9 @@ code project_progress.md
恭喜!您已经掌握了文档编写的基本流程。
继续阅读:
- 📋 [项目进度跟踪](00_Management/01_Project_Progress.md)
- 📝 [任务清单](00_Management/03_Task_Checklist.md)
- 📊 [项目看板](00_Management/05_Project_Dashboard.md)
- 📋 [项目进度跟踪](docs/design/00_Management/01_Project_Progress.md)
- 📝 [任务清单](docs/design/00_Management/03_Task_Checklist.md)
- 📊 [项目看板](docs/design/00_Management/05_Project_Dashboard.md)
- ⚙️ [Cursor Rules说明](.cursorrules)
---

View File

@ -15,44 +15,44 @@
### 00\_管理与标准 (Management)
- [📋 项目进度跟踪](00_Management/01_Project_Progress.md)
- [📏 交付标准](00_Management/02_Delivery_Standards.md)
- [✅ 任务清单](00_Management/03_Task_Checklist.md)
- [✍️ 编写指南](00_Management/04_Writing_Guide.md)
- [🧭 目录治理基线](00_Management/06_Directory_Governance_Baseline.md)
- [🤖 AI Agent 维护SOP](00_Management/08_AI_Agent_Maintenance_SOP.md)
- [📈 AI 文档优化规划](00_Management/09_AI_Document_Optimization_Plan.md)
- [🎯 AI 检索白名单](00_Management/10_AI_Retrieval_Whitelist.md)
- [🗂️ 主文档章节导航](00_Management/11_Main_Doc_Chapter_Index.md)
- [🧪 AI 每周抽检模板](00_Management/12_AI_Weekly_Audit_Template.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)
- [✍️ 编写指南](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)
- [🏗️ 系统概述](01_High_Level/01_System_Overview.md)
- [🏗️ 系统架构设计](01_High_Level/02_System_Architecture.md)
- [🏗️ 概要设计说明书](01_High_Level/03_Summary_Design.md)
- [📊 系统架构图](01_High_Level/04_System_Diagrams.md)
- [🏗️ 系统概述](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)
- [🔧 详细设计说明书](02_Detailed/01_Detailed_Design.md)
- [🔧 模块功能设计](02_Detailed/02_Module_Design.md)
- [🔧 报装CA集成设计](02_Detailed/03_CA_Installation_Design.md)
- [🔧 详细设计说明书](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)
### 03\_技术专项 (Technical)
- [🗄️ 数据库设计](03_Technical/01_Database_Design.md)
- [🗄️ 单表规格说明](03_Technical/02_Table_Specs.md)
- [🔌 接口设计](03_Technical/03_Interface_Design.md)
- [🔒 安全设计](03_Technical/04_Security_Design.md)
- [🚀 部署设计](03_Technical/05_Deployment_Design.md)
- [🔑 敏感数据加密方案](03_Technical/06_Sensitive_Data_Encryption.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)
- [🔒 安全设计](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集成概述](04_Appendix/01_Overview_CA.md)
- [附录 02: CA数据库设计](04_Appendix/02_Database_Design_CA.md)
- [附录 03: CA集成总结](04_Appendix/03_CA_Integration_Summary.md)
- [附录 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)
## 🏗️ 技术架构
@ -103,9 +103,9 @@ graph TB
- 进入仓库后,优先阅读 `AGENTS.md`
- 修改正式文档前,先检查:
- `00_Management/01_Project_Progress.md`
- `00_Management/02_Delivery_Standards.md`
- `00_Management/03_Task_Checklist.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` 工作流

View File

@ -6,6 +6,11 @@
## 子目录说明
- `docs/design/00_Management/`:项目管理、治理基线与 AI 维护规范
- `docs/design/01_Overview/`:概要设计主文档与总体架构
- `docs/design/02_Detailed_Design/`:详细设计主文档与模块设计
- `docs/design/03_Technical_Design/`:数据库、接口、安全、部署等技术专项
- `docs/design/04_Appendix/`:附录与历史归档资料
- `guides/`:执行指南与映射口径(优先使用)
- `design/`:设计辅助文档
- `research/`:调研资料
@ -21,4 +26,3 @@
- 该目录作为“辅助事实来源”,不替代主文档
- 如与主文档冲突,优先以主文档与当次用户要求为准

View File

@ -111,12 +111,13 @@
| 变更时间 | 变更类型 | 变更内容 | 变更原因 | 影响评估 |
| ---------- | ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 2026-03-11 | AI 文档优化专项全自动落地 | 按 `00_Management/09_AI_Document_Optimization_Plan.md` 一次性完成四阶段动作:补齐一级目录 `README.md`7/7、新增 `00_Management/10_AI_Retrieval_Whitelist.md`、新增 `00_Management/11_Main_Doc_Chapter_Index.md`、为六个主文档补齐 Front Matter6/6、新增 `00_Management/12_AI_Weekly_Audit_Template.md` 与首份周检记录 `00_Management/13_AI_Weekly_Audit_2026W11.md`,并新增 `scripts/check-ai-doc-governance.sh` 接入 pre-push 门禁 | 用户要求“全自动全弄了”,需将 AI 优化规划从阶段计划直接落地为可执行资产与可验证结果 | 正面影响AI 文档体系已形成“目录索引 + 检索白名单 + 元数据标准 + 导航索引 + 周检机制 + 自动门禁”闭环;可显著提升检索命中率、减少历史资料干扰、增强跨代理执行一致性与可追溯性 |
| 2026-03-11 | AI 文档优化专项规划 | 新增 `00_Management/09_AI_Document_Optimization_Plan.md`,形成 4 周可执行优化方案2026-03-12 至 2026-04-08明确现状基线、阶段目标、交付物、验收指标与风险应对重点覆盖目录索引补齐、主文档 Front Matter 标准化、超长文档可检索化与 AI 抽检门禁固化 | 用户要求“规划文档是否对 AI 优化”,需要将现状评估转化为可执行的阶段计划与量化验收标准 | 正面影响AI 文档治理从“规则存在”升级为“按周推进 + 指标验收”的专项机制,可提升 AI 检索命中率、降低历史文档干扰并增强跨代理一致性 |
| 2026-03-11 | AI Agent 维护SOP落地 | 新增 `00_Management/08_AI_Agent_Maintenance_SOP.md`,定义 AI Agent 在本仓库的目标范围、执行前检查、普通任务与结构任务流程、冲突优先级、质量门禁与提交规范;与现有目录治理基线、迁移模板和 pre-commit 校验形成闭环 | 用户要求提供“一份适用于 AI Agent 的项目维护方式”,需要形成可直接执行的标准操作流程 | 正面影响AI Agent 执行路径从“经验驱动”升级为“规则驱动 + 流程驱动”,可降低误改风险、提升跨代理一致性与维护可追溯性 |
| 2026-03-11 | 目录治理工程化基线落地 | 新增 `00_Management/06_Directory_Governance_Baseline.md`(目录治理基线清单)与 `00_Management/07_Migration_Mapping_Template.md`迁移映射模板明确主文档单一真源、Archive 边界、目录命名规则、迁移流程、门禁指标及角色责任;新增 `.pre-commit-config.yaml``scripts/precommit-validate-markdown.sh`,将 `make validate-file``make check-links``make validate-mermaid` 纳入提交前/推送前校验草案 | 用户要求提供“可执行的目录治理方案”,并确认需要直接落地模板与自动化校验入口 | 正面影响,目录治理从“规则说明”升级为“可执行流程 + 模板 + 工具门禁”;可显著降低平行版本扩散、链接失效和图文不一致风险,提升后续文档维护效率与交付稳定性 |
| 2026-03-10 | 统一主详设整编 | 将 `02_Detailed/01_Detailed_Design.md` 重构为统一《福建水务营收系统详细设计说明书》整合模块设计、CA电子签章、数据库、接口、安全、部署等分散文档内容统一系统名称、章节体系、模块/接口编号及数据库口径为达梦数据库 8.0+,并清理部署章节残留脚本碎片 | 用户要求以唯一主详设文件完成整编交付,避免多份详设并存、章节口径不一致及旧数据库表述残留 | 正面影响,主详设结构更完整统一,可直接交付实施,数据库与章节口径一致,后续维护与评审成本显著降低 |
| 2026-03-10 | Archive归档整理 | 重组 `04_Appendix/Archive/` 历史资料目录,按需求、操作手册、历史设计、原始附件、数据字典、整合资料分层归档;迁移 Markdown 与配套 `_images` 目录;同步修正 `00_Management/04_Writing_Guide.md` 中数据字典旧路径引用 | 用户要求提升历史资料可检索性,明确 Archive 职责边界,并避免图片相对路径失效与旧引用残留 | 正面影响,历史资料结构更清晰,检索效率提升,引用路径与目录职责统一,降低后续维护成本 |
| 2026-03-11 | 正式设计文档目录体系迁移至 `docs/design/` | 将原仓库根目录下 `00_Management/``01_High_Level/``02_Detailed/``03_Technical/``04_Appendix/` 全量迁移至 `docs/design/` 下新目录:`00_Management/``01_Overview/``02_Detailed_Design/``03_Technical_Design/``04_Appendix/`;同步迁移 Archive 配套 `_images` 目录;批量修复仓库内路径引用,更新 `README.md``AGENTS.md``CLAUDE.md``scripts/unified_export.sh``scripts/check-ai-doc-governance.sh` 等关键入口与工具脚本,确保导出/校验链路与目录结构一致 | 用户要求将既有五大目录体系统一迁移到 `docs/design` 目录体系下,并要求自动完成迁移与路径治理 | 正面影响,正式设计文档已实现统一收口,目录边界更清晰;工具链与治理脚本已与新结构对齐,后续维护、检索、导出与跨代理协作成本显著降低 |
| 2026-03-11 | AI 文档优化专项全自动落地 | 按 `docs/design/00_Management/09_AI_Document_Optimization_Plan.md` 一次性完成四阶段动作:补齐一级目录 `README.md`7/7、新增 `docs/design/00_Management/10_AI_Retrieval_Whitelist.md`、新增 `docs/design/00_Management/11_Main_Doc_Chapter_Index.md`、为六个主文档补齐 Front Matter6/6、新增 `docs/design/00_Management/12_AI_Weekly_Audit_Template.md` 与首份周检记录 `docs/design/00_Management/13_AI_Weekly_Audit_2026W11.md`,并新增 `scripts/check-ai-doc-governance.sh` 接入 pre-push 门禁 | 用户要求“全自动全弄了”,需将 AI 优化规划从阶段计划直接落地为可执行资产与可验证结果 | 正面影响AI 文档体系已形成“目录索引 + 检索白名单 + 元数据标准 + 导航索引 + 周检机制 + 自动门禁”闭环;可显著提升检索命中率、减少历史资料干扰、增强跨代理执行一致性与可追溯性 |
| 2026-03-11 | AI 文档优化专项规划 | 新增 `docs/design/00_Management/09_AI_Document_Optimization_Plan.md`,形成 4 周可执行优化方案2026-03-12 至 2026-04-08明确现状基线、阶段目标、交付物、验收指标与风险应对重点覆盖目录索引补齐、主文档 Front Matter 标准化、超长文档可检索化与 AI 抽检门禁固化 | 用户要求“规划文档是否对 AI 优化”,需要将现状评估转化为可执行的阶段计划与量化验收标准 | 正面影响AI 文档治理从“规则存在”升级为“按周推进 + 指标验收”的专项机制,可提升 AI 检索命中率、降低历史文档干扰并增强跨代理一致性 |
| 2026-03-11 | AI Agent 维护SOP落地 | 新增 `docs/design/00_Management/08_AI_Agent_Maintenance_SOP.md`,定义 AI Agent 在本仓库的目标范围、执行前检查、普通任务与结构任务流程、冲突优先级、质量门禁与提交规范;与现有目录治理基线、迁移模板和 pre-commit 校验形成闭环 | 用户要求提供“一份适用于 AI Agent 的项目维护方式”,需要形成可直接执行的标准操作流程 | 正面影响AI Agent 执行路径从“经验驱动”升级为“规则驱动 + 流程驱动”,可降低误改风险、提升跨代理一致性与维护可追溯性 |
| 2026-03-11 | 目录治理工程化基线落地 | 新增 `docs/design/00_Management/06_Directory_Governance_Baseline.md`(目录治理基线清单)与 `docs/design/00_Management/07_Migration_Mapping_Template.md`迁移映射模板明确主文档单一真源、Archive 边界、目录命名规则、迁移流程、门禁指标及角色责任;新增 `.pre-commit-config.yaml``scripts/precommit-validate-markdown.sh`,将 `make validate-file``make check-links``make validate-mermaid` 纳入提交前/推送前校验草案 | 用户要求提供“可执行的目录治理方案”,并确认需要直接落地模板与自动化校验入口 | 正面影响,目录治理从“规则说明”升级为“可执行流程 + 模板 + 工具门禁”;可显著降低平行版本扩散、链接失效和图文不一致风险,提升后续文档维护效率与交付稳定性 |
| 2026-03-10 | 统一主详设整编 | 将 `docs/design/02_Detailed_Design/01_Detailed_Design.md` 重构为统一《福建水务营收系统详细设计说明书》整合模块设计、CA电子签章、数据库、接口、安全、部署等分散文档内容统一系统名称、章节体系、模块/接口编号及数据库口径为达梦数据库 8.0+,并清理部署章节残留脚本碎片 | 用户要求以唯一主详设文件完成整编交付,避免多份详设并存、章节口径不一致及旧数据库表述残留 | 正面影响,主详设结构更完整统一,可直接交付实施,数据库与章节口径一致,后续维护与评审成本显著降低 |
| 2026-03-10 | Archive归档整理 | 重组 `docs/design/04_Appendix/Archive/` 历史资料目录,按需求、操作手册、历史设计、原始附件、数据字典、整合资料分层归档;迁移 Markdown 与配套 `_images` 目录;同步修正 `docs/design/00_Management/04_Writing_Guide.md` 中数据字典旧路径引用 | 用户要求提升历史资料可检索性,明确 Archive 职责边界,并避免图片相对路径失效与旧引用残留 | 正面影响,历史资料结构更清晰,检索效率提升,引用路径与目录职责统一,降低后续维护成本 |
| 2024-12-19 | 微网厅功能对齐 | 根据福建水投微网厅操作手册核对调整子系统4功能删除WECHAT-005营业网点服务中的预约/排队叫号/预约提醒功能在WECHAT-006业务办理服务中添加缺失的一户多人口申请功能将更名过户申请分离为独立的更名业务和过户业务 | 用户要求子系统4不要出现操作手册中没有的功能并核对删除多余功能 | 正面影响,确保微网厅系统功能与实际操作手册完全一致,避免设计与实施不符 |
| 2025-12-19 | 文档一致性检查 | 检查新-概要设计说明书.md子系统图与描述一致性确认10个子系统架构完全一致更新project_progress.md以反映当前架构SYS-001到SYS-010的完整10子系统设计 | 用户要求检查子系统图表与描述的一致性,并相应调整项目进度文档 | 正面影响,确保文档架构描述准确,项目进度文档与实际设计完全对齐 |
| 2024-12-19 | 工具链修复 | 修复文档验证工具中的代码块检查逻辑 | 解决make full-build验证失败问题 | 正面影响,提升工具链可用性 |

View File

@ -226,7 +226,7 @@ onMounted(() => {
### 📚 历史资料管理要求
- `04_Appendix/Archive/` 应按资料类别进行分层归档,避免需求、手册、历史设计、原始附件混放。
- `docs/design/04_Appendix/Archive/` 应按资料类别进行分层归档,避免需求、手册、历史设计、原始附件混放。
- Markdown 文档与其同名 `_images` 目录必须成组维护与迁移,禁止拆散导致相对路径失效。
- 管理类文档中的历史资料引用应统一指向 Archive 新路径,避免继续引用旧目录。
- 原始附件应集中存放于独立目录,便于追溯原件来源与版本。

View File

@ -138,16 +138,32 @@
## ✅ 最新完成任务 (持续更新)
### 📋 正式设计目录迁移至 `docs/design`
- [x] **完成五大正式文档目录迁移** ✅ (2026-03-11)
- [x] 将 `00_Management/` 迁移至 `docs/design/00_Management/`
- [x] 将 `01_High_Level/` 迁移至 `docs/design/01_Overview/`
- [x] 将 `02_Detailed/` 迁移至 `docs/design/02_Detailed_Design/`
- [x] 将 `03_Technical/` 迁移至 `docs/design/03_Technical_Design/`
- [x] 将 `04_Appendix/` 迁移至 `docs/design/04_Appendix/`(含 Archive 资料与配套图片目录)✅
- [x] **完成迁移后的路径与工具链修复** ✅ (2026-03-11)
- [x] 全仓库替换旧目录引用为 `docs/design` 新路径 ✅
- [x] 更新入口文档:`README.md``docs/README.md``AGENTS.md``CLAUDE.md`
- [x] 更新导出脚本:`scripts/unified_export.sh`
- [x] 更新 AI 治理校验脚本:`scripts/check-ai-doc-governance.sh`
- [x] 执行断链与 Mermaid 校验,确认迁移后结构可用 ✅
### 📋 Archive 历史资料归档整理
- [x] **重组 `04_Appendix/Archive/` 目录结构** ✅ (2026-03-10)
- [x] **重组 `docs/design/04_Appendix/Archive/` 目录结构** ✅ (2026-03-10)
- [x] 创建 `01_Requirements``02_Manuals``03_Design_Docs``04_Original_Attachments``05_Data_Dictionary``07_Integration` 分类目录 ✅
- [x] 将需求类、操作手册类、历史设计类、原始附件类、数据字典类、整合资料类文件迁移到对应目录 ✅
- [x] 保持 Markdown 与同名 `_images` 目录成组迁移,确保相对路径不失效 ✅
- [x] 清理空的 `新营收系统需求相关材料/` 目录 ✅
- [x] **修正历史引用路径** ✅ (2026-03-10)
- [x] 更新 `00_Management/04_Writing_Guide.md``营收数据字典.md` 的旧路径引用 ✅
- [x] 更新 `docs/design/00_Management/04_Writing_Guide.md` 中 `营收数据字典.md` 的旧路径引用 ✅
- [x] 全仓库搜索确认 `ori_doc/营收数据字典.md` 无残留引用 ✅
- [x] 抽查已迁移文档图片引用路径正常 ✅
- [x] 更新项目进度文件记录本次归档整理结果 ✅
@ -168,8 +184,8 @@
### 📋 可执行目录治理方案落地
- [x] **新增目录治理基线与迁移模板** ✅ (2026-03-11)
- [x] 新增 `00_Management/06_Directory_Governance_Baseline.md`明确主文档单一真源、Archive 边界、命名规则、迁移流程、门禁指标 ✅
- [x] 新增 `00_Management/07_Migration_Mapping_Template.md`,提供批次化迁移映射、引用修复、校验记录、风险回退模板 ✅
- [x] 新增 `docs/design/00_Management/06_Directory_Governance_Baseline.md`明确主文档单一真源、Archive 边界、命名规则、迁移流程、门禁指标 ✅
- [x] 新增 `docs/design/00_Management/07_Migration_Mapping_Template.md`,提供批次化迁移映射、引用修复、校验记录、风险回退模板 ✅
- [x] 新增 `.pre-commit-config.yaml` 草案,将 `validate-file``check-links``validate-mermaid` 纳入提交前/推送前校验流程 ✅
- [x] 新增 `scripts/precommit-validate-markdown.sh`,支持按本次变更文件逐一执行 `make validate-file`
- [x] 更新项目进度文件记录本次目录治理工程化动作 ✅
@ -179,7 +195,7 @@
### 📋 AI Agent 标准维护方式落地
- [x] **新增 AI Agent 维护SOP 文档** ✅ (2026-03-11)
- [x] 新增 `00_Management/08_AI_Agent_Maintenance_SOP.md`,定义 AI Agent 目标范围、角色边界、执行前检查、任务流程与决策规则 ✅
- [x] 新增 `docs/design/00_Management/08_AI_Agent_Maintenance_SOP.md`,定义 AI Agent 目标范围、角色边界、执行前检查、任务流程与决策规则 ✅
- [x] 明确普通维护任务与结构治理任务的可执行步骤与校验命令 ✅
- [x] 固化 AI Agent 质量门禁断链、Mermaid、平行稿、口径冲突、台账同步
- [x] 补充提交规范与周期化巡检节奏,便于团队长期执行 ✅
@ -190,7 +206,7 @@
### 📋 AI 文档优化专项计划建立
- [x] **新增 AI 文档优化规划文档** ✅ (2026-03-11)
- [x] 新增 `00_Management/09_AI_Document_Optimization_Plan.md`,明确当前 AI 友好性短板与基线指标 ✅
- [x] 新增 `docs/design/00_Management/09_AI_Document_Optimization_Plan.md`,明确当前 AI 友好性短板与基线指标 ✅
- [x] 输出 4 周执行计划2026-03-12 至 2026-04-08覆盖目录索引、Front Matter、长文档可检索化与门禁固化 ✅
- [x] 定义量化验收指标README 覆盖率、Front Matter 覆盖率、一致性抽检、断链与 Mermaid 指标) ✅
- [x] 明确专项 Backlog 优先级P0/P1/P2与风险应对策略 ✅
@ -202,16 +218,16 @@
- [x] **第 1 周:检索入口标准化** ✅ (2026-03-11)
- [x] 补齐一级目录 `README.md` 索引7/7
- [x] 新增 AI 检索优先白名单:`00_Management/10_AI_Retrieval_Whitelist.md` ✅
- [x] 新增 AI 检索优先白名单:`docs/design/00_Management/10_AI_Retrieval_Whitelist.md` ✅
- [x] **第 2 周:主文档元数据统一** ✅ (2026-03-11)
- [x] 六个主文档补齐 Front Matter 标准字段 ✅
- [x] **第 3 周:长文档可检索化** ✅ (2026-03-11)
- [x] 新增主文档章节导航索引:`00_Management/11_Main_Doc_Chapter_Index.md` ✅
- [x] 新增主文档章节导航索引:`docs/design/00_Management/11_Main_Doc_Chapter_Index.md` ✅
- [x] 为超长主文档补充快速定位导航(概要/数据库主文档) ✅
- [x] **第 4 周:门禁与抽检固化** ✅ (2026-03-11)
- [x] 新增每周抽检模板:`00_Management/12_AI_Weekly_Audit_Template.md` ✅
- [x] 新增每周抽检模板:`docs/design/00_Management/12_AI_Weekly_Audit_Template.md` ✅
- [x] 新增 AI 治理检查脚本:`scripts/check-ai-doc-governance.sh`,并接入 pre-push ✅
- [x] 完成首次周检记录:`00_Management/13_AI_Weekly_Audit_2026W11.md` ✅
- [x] 完成首次周检记录:`docs/design/00_Management/13_AI_Weekly_Audit_2026W11.md` ✅
- [x] 更新项目进度文件记录本次全自动落地动作 ✅
## ✅ 最新完成任务 (2024-12-19)

View File

@ -176,7 +176,7 @@
3. **数据模型**
- **ER图设计**:实体关系图
- **表关系说明**:外键关系和业务关联
- **数据字典**:参考 `04_Appendix/Archive/05_Data_Dictionary/营收数据字典.md`
- **数据字典**:参考 `docs/design/04_Appendix/Archive/05_Data_Dictionary/营收数据字典.md`
## 五、自动化工具和脚本
@ -289,7 +289,7 @@ grep -E "CREATE TABLE|COMMENT ON" sql/*.sql
### 8.2 文档体系架构(参考现有经验)
**文档关系网络**
```
```text
新-集成文档索引.md (主入口)
├── 新-概要设计说明书.md
├── 新-详细设计说明书.md
@ -322,7 +322,7 @@ grep -E "CREATE TABLE|COMMENT ON" sql/*.sql
**技术资源**
- **API文档**:基于 `/api/【IF】福建水务营收系统.openapi.json`
- **数据库字典**:基于 `/sql` 文件和 `04_Appendix/Archive/05_Data_Dictionary/营收数据字典.md`
- **数据库字典**:基于 `/sql` 文件和 `docs/design/04_Appendix/Archive/05_Data_Dictionary/营收数据字典.md`
- **架构图表**:参考 `architecture_diagram.html``images/architecture_diagram.png`
**参考资源库**

View File

@ -35,10 +35,10 @@ pie title 文档完成度分布
| 项目 | 状态 | 说明 |
|------|------|------|
| 目录分类重组 | ✅ 已完成 | `04_Appendix/Archive/` 已按需求、手册、设计、原始附件、数据字典、整合资料分层归档 |
| 目录分类重组 | ✅ 已完成 | `docs/design/04_Appendix/Archive/` 已按需求、手册、设计、原始附件、数据字典、整合资料分层归档 |
| 资料迁移 | ✅ 已完成 | Markdown、docx、html、xlsx 已迁移到对应分类目录 |
| 图片路径校验 | ✅ 已完成 | Markdown 与同名 `_images` 目录成组迁移,图片相对路径保持有效 |
| 引用修正 | ✅ 已完成 | `00_Management/04_Writing_Guide.md` 已修正为新的数据字典路径 |
| 引用修正 | ✅ 已完成 | `docs/design/00_Management/04_Writing_Guide.md` 已修正为新的数据字典路径 |
## 🎉 项目完成总结

View File

@ -13,35 +13,35 @@
## 2. 适用范围
- 本清单适用于仓库根目录及全部子目录的 Markdown 正式文档治理。
- 本清单与 `00_Management/02_Delivery_Standards.md`、`00_Management/04_Writing_Guide.md` 联合生效。
- 本清单与 `docs/design/00_Management/02_Delivery_Standards.md`、`docs/design/00_Management/04_Writing_Guide.md` 联合生效。
- 冲突处理优先级:用户当次要求 > 主文档统一口径 > 本清单 > Archive 历史资料。
## 3. 主文档单一真源
以下文件为正式交付主文档,新增正式内容必须优先并入对应主文档:
- `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`
- `docs/design/01_Overview/03_Summary_Design.md`
- `docs/design/02_Detailed_Design/01_Detailed_Design.md`
- `docs/design/03_Technical_Design/01_Database_Design.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`
治理规则:
- 禁止新增“新-xxx”“最终版”“修订版”等平行正式稿。
- 历史版本仅允许进入 `04_Appendix/Archive/`,并保留来源说明。
- 历史版本仅允许进入 `docs/design/04_Appendix/Archive/`,并保留来源说明。
- 如需拆分主文档章节,应先在主文档中定义章节入口与回链。
## 4. 目录与命名规则
### 4.1 目录职责
- `00_Management/`:管理制度、进度、任务、治理规则。
- `01_High_Level/`:概要设计(结构、边界、职责、关键接口)。
- `02_Detailed/`:详细设计(流程、规则、约束、模块实现层面设计)。
- `03_Technical/`:数据库、接口、安全、部署等专题设计。
- `04_Appendix/Archive/`:历史资料归档,不作为正式主稿替代。
- `docs/design/00_Management/`:管理制度、进度、任务、治理规则。
- `docs/design/01_Overview/`:概要设计(结构、边界、职责、关键接口)。
- `docs/design/02_Detailed_Design/`:详细设计(流程、规则、约束、模块实现层面设计)。
- `docs/design/03_Technical_Design/`:数据库、接口、安全、部署等专题设计。
- `docs/design/04_Appendix/Archive/`:历史资料归档,不作为正式主稿替代。
### 4.2 文件命名
@ -59,8 +59,8 @@
每次目录或文档结构调整按以下步骤执行:
1. 在 `00_Management/03_Task_Checklist.md` 新增或勾选对应任务项。
2. 建立本次变更的《迁移映射表》(见 `00_Management/07_Migration_Mapping_Template.md`)。
1. 在 `docs/design/00_Management/03_Task_Checklist.md` 新增或勾选对应任务项。
2. 建立本次变更的《迁移映射表》(见 `docs/design/00_Management/07_Migration_Mapping_Template.md`)。
3. 执行内容迁移Markdown 与 `_images` 目录必须成组迁移)。
4. 修复相对链接、目录入口链接、文内锚点引用。
5. 执行校验命令:
@ -68,7 +68,7 @@
- `make check-links`
- `make validate-mermaid`
- `make check-ai-governance`
6. 在 `00_Management/01_Project_Progress.md` 记录变更条目并说明影响。
6. 在 `docs/design/00_Management/01_Project_Progress.md` 记录变更条目并说明影响。
## 6. 验收门禁

View File

@ -27,7 +27,7 @@
| 序号 | 受影响文件 | 引用类型 | 修复前 | 修复后 | 验证结果 |
| --- | --- | --- | --- | --- | --- |
| 1 | `00_Management/04_Writing_Guide.md` | 相对路径 | `旧引用` | `新引用` | 通过 / 未通过 |
| 1 | `docs/design/00_Management/04_Writing_Guide.md` | 相对路径 | `旧引用` | `新引用` | 通过 / 未通过 |
## 5. 校验记录
@ -53,5 +53,5 @@
- [ ] 迁移映射表字段已完整填写
- [ ] 所有受影响链接已修复并验证通过
- [ ] 模块/接口编号及正文引用已同步
- [ ] `00_Management/01_Project_Progress.md` 已登记
- [ ] `00_Management/03_Task_Checklist.md` 已勾选
- [ ] `docs/design/00_Management/01_Project_Progress.md` 已登记
- [ ] `docs/design/00_Management/03_Task_Checklist.md` 已勾选

View File

@ -15,16 +15,16 @@
每次任务开始前AI Agent 必须先读取:
1. `00_Management/01_Project_Progress.md`
2. `00_Management/02_Delivery_Standards.md`
3. `00_Management/03_Task_Checklist.md`
1. `docs/design/00_Management/01_Project_Progress.md`
2. `docs/design/00_Management/02_Delivery_Standards.md`
3. `docs/design/00_Management/03_Task_Checklist.md`
4. 与任务直接相关的目标文档
结构性调整任务需额外读取:
- `00_Management/04_Writing_Guide.md`
- `00_Management/10_AI_Retrieval_Whitelist.md`
- `00_Management/11_Main_Doc_Chapter_Index.md`
- `docs/design/00_Management/04_Writing_Guide.md`
- `docs/design/00_Management/10_AI_Retrieval_Whitelist.md`
- `docs/design/00_Management/11_Main_Doc_Chapter_Index.md`
- `docs/guides/BACKEND_CURRENT_STATUS.md`
- `docs/guides/BACKEND_TABLE_MAPPING.md`
@ -44,7 +44,7 @@
### 4.2 结构性治理任务(迁移、重命名、归档整理)
1. 先创建迁移批次,使用 `00_Management/07_Migration_Mapping_Template.md`。
1. 先创建迁移批次,使用 `docs/design/00_Management/07_Migration_Mapping_Template.md`。
2. Markdown 与同名 `_images/` 目录成组处理。
3. 修复全部受影响相对路径。
4. 完整执行校验:
@ -59,7 +59,7 @@
1. 用户当次明确要求
2. 主文档既有统一口径
3. `docs/guides/` 最新映射文档
4. `04_Appendix/Archive/` 历史资料
4. `docs/design/04_Appendix/Archive/` 历史资料
- 无依据时默认“保守不扩写”,先做结构与一致性修复。
- 涉及高风险调整(编号体系、数据库口径、模块拆分)时,先给出影响面再执行。

View File

@ -15,8 +15,8 @@
### 2.1 已具备能力
- 已建立仓库级代理约束:`AGENTS.md`
- 已建立 AI Agent 执行流程:`00_Management/08_AI_Agent_Maintenance_SOP.md`
- 已建立目录治理基线与迁移模板:`00_Management/06_Directory_Governance_Baseline.md`、`00_Management/07_Migration_Mapping_Template.md`
- 已建立 AI Agent 执行流程:`docs/design/00_Management/08_AI_Agent_Maintenance_SOP.md`
- 已建立目录治理基线与迁移模板:`docs/design/00_Management/06_Directory_Governance_Baseline.md`、`docs/design/00_Management/07_Migration_Mapping_Template.md`
- 已接入提交前/推送前校验:`.pre-commit-config.yaml`
### 2.2 主要短板
@ -32,9 +32,9 @@
- 一级目录 README 覆盖率0/7
- 主文档 Front Matter 覆盖率0/6
- 超长文档(>1500 行)示例:
- `01_High_Level/03_Summary_Design.md`
- `03_Technical/01_Database_Design.md`
- `04_Appendix/Archive/05_Data_Dictionary/营收数据字典.md`
- `docs/design/01_Overview/03_Summary_Design.md`
- `docs/design/03_Technical_Design/01_Database_Design.md`
- `docs/design/04_Appendix/Archive/05_Data_Dictionary/营收数据字典.md`
## 3. 优化目标2026-03-12 至 2026-04-08
@ -50,11 +50,11 @@
交付物:
- 一级目录 `README.md` 索引模板与落地:
- `00_Management/README.md`
- `01_High_Level/README.md`
- `02_Detailed/README.md`
- `03_Technical/README.md`
- `04_Appendix/README.md`
- `docs/design/00_Management/README.md`
- `docs/design/01_Overview/README.md`
- `docs/design/02_Detailed_Design/README.md`
- `docs/design/03_Technical_Design/README.md`
- `docs/design/04_Appendix/README.md`
- `docs/README.md`
- `scripts/README.md`
- AI 检索优先白名单(主文档 + 管理基线)清单文档。
@ -168,9 +168,9 @@
- 已补齐一级目录 `README.md` 索引7/7
- 已为六个主文档补齐 Front Matter6/6
- 已新增 AI 检索白名单:`00_Management/10_AI_Retrieval_Whitelist.md`。
- 已新增主文档章节导航:`00_Management/11_Main_Doc_Chapter_Index.md`。
- 已新增每周抽检模板:`00_Management/12_AI_Weekly_Audit_Template.md`。
- 已新增 AI 检索白名单:`docs/design/00_Management/10_AI_Retrieval_Whitelist.md`。
- 已新增主文档章节导航:`docs/design/00_Management/11_Main_Doc_Chapter_Index.md`。
- 已新增每周抽检模板:`docs/design/00_Management/12_AI_Weekly_Audit_Template.md`。
- 已新增 AI 治理检查脚本:`scripts/check-ai-doc-governance.sh`,并接入 pre-push。
### 当前指标

View File

@ -8,30 +8,30 @@
### P0主文档单一真源必须优先
1. `01_High_Level/03_Summary_Design.md`
2. `02_Detailed/01_Detailed_Design.md`
3. `03_Technical/01_Database_Design.md`
4. `03_Technical/03_Interface_Design.md`
5. `03_Technical/04_Security_Design.md`
6. `03_Technical/05_Deployment_Design.md`
1. `docs/design/01_Overview/03_Summary_Design.md`
2. `docs/design/02_Detailed_Design/01_Detailed_Design.md`
3. `docs/design/03_Technical_Design/01_Database_Design.md`
4. `docs/design/03_Technical_Design/03_Interface_Design.md`
5. `docs/design/03_Technical_Design/04_Security_Design.md`
6. `docs/design/03_Technical_Design/05_Deployment_Design.md`
### P1治理与口径基线
1. `00_Management/06_Directory_Governance_Baseline.md`
2. `00_Management/08_AI_Agent_Maintenance_SOP.md`
3. `00_Management/09_AI_Document_Optimization_Plan.md`
4. `00_Management/01_Project_Progress.md`
5. `00_Management/03_Task_Checklist.md`
1. `docs/design/00_Management/06_Directory_Governance_Baseline.md`
2. `docs/design/00_Management/08_AI_Agent_Maintenance_SOP.md`
3. `docs/design/00_Management/09_AI_Document_Optimization_Plan.md`
4. `docs/design/00_Management/01_Project_Progress.md`
5. `docs/design/00_Management/03_Task_Checklist.md`
### P2辅助映射资料
1. `docs/guides/BACKEND_CURRENT_STATUS.md`
2. `docs/guides/BACKEND_TABLE_MAPPING.md`
3. `00_Management/04_Writing_Guide.md`
3. `docs/design/00_Management/04_Writing_Guide.md`
### P3历史资料仅核对来源
- `04_Appendix/Archive/**`
- `docs/design/04_Appendix/Archive/**`
## 3. 使用规则

View File

@ -8,7 +8,7 @@
### 2.1 概要设计主文档
文档:`01_High_Level/03_Summary_Design.md`
文档:`docs/design/01_Overview/03_Summary_Design.md`
| 快速入口 | 链接 |
| --- | --- |
@ -28,7 +28,7 @@
### 2.2 详细设计主文档
文档:`02_Detailed/01_Detailed_Design.md`
文档:`docs/design/02_Detailed_Design/01_Detailed_Design.md`
| 快速入口 | 链接 |
| --- | --- |
@ -39,7 +39,7 @@
### 2.3 数据库设计主文档
文档:`03_Technical/01_Database_Design.md`
文档:`docs/design/03_Technical_Design/01_Database_Design.md`
| 快速入口 | 链接 |
| --- | --- |
@ -51,7 +51,7 @@
### 2.4 接口设计主文档
文档:`03_Technical/03_Interface_Design.md`
文档:`docs/design/03_Technical_Design/03_Interface_Design.md`
| 快速入口 | 链接 |
| --- | --- |
@ -65,8 +65,8 @@
| 文档 | 快速入口 |
| --- | --- |
| `03_Technical/04_Security_Design.md` | [安全设计概述](../03_Technical/04_Security_Design.md#安全设计概述)、[数据安全设计](../03_Technical/04_Security_Design.md#数据安全设计) |
| `03_Technical/05_Deployment_Design.md` | [部署概述](../03_Technical/05_Deployment_Design.md#部署概述)、[部署架构](../03_Technical/05_Deployment_Design.md#部署架构)、[监控运维](../03_Technical/05_Deployment_Design.md#监控运维) |
| `docs/design/03_Technical_Design/04_Security_Design.md` | [安全设计概述](../03_Technical/04_Security_Design.md#安全设计概述)、[数据安全设计](../03_Technical/04_Security_Design.md#数据安全设计) |
| `docs/design/03_Technical_Design/05_Deployment_Design.md` | [部署概述](../03_Technical/05_Deployment_Design.md#部署概述)、[部署架构](../03_Technical/05_Deployment_Design.md#部署架构)、[监控运维](../03_Technical/05_Deployment_Design.md#监控运维) |
## 3. 使用说明

View File

@ -25,9 +25,9 @@
| 序号 | 抽检项 | 抽检文件 | 结论 | 问题说明 | 修复状态 |
| --- | --- | --- | --- | --- | --- |
| 1 | 系统名称一致性 | `01_High_Level/03_Summary_Design.md` | 通过/不通过 | 待填写 | 待处理/已修复 |
| 2 | 数据库口径一致性 | `03_Technical/01_Database_Design.md` | 通过/不通过 | 待填写 | 待处理/已修复 |
| 3 | 接口编号规范 | `03_Technical/03_Interface_Design.md` | 通过/不通过 | 待填写 | 待处理/已修复 |
| 1 | 系统名称一致性 | `docs/design/01_Overview/03_Summary_Design.md` | 通过/不通过 | 待填写 | 待处理/已修复 |
| 2 | 数据库口径一致性 | `docs/design/03_Technical_Design/01_Database_Design.md` | 通过/不通过 | 待填写 | 待处理/已修复 |
| 3 | 接口编号规范 | `docs/design/03_Technical_Design/03_Interface_Design.md` | 通过/不通过 | 待填写 | 待处理/已修复 |
## 4. 校验命令执行记录

View File

@ -25,9 +25,9 @@
| 序号 | 抽检项 | 抽检文件 | 结论 | 问题说明 | 修复状态 |
| --- | --- | --- | --- | --- | --- |
| 1 | 系统名称一致性 | `01_High_Level/03_Summary_Design.md` | 通过 | 未发现“系统名称混用” | 已确认 |
| 2 | 数据库口径一致性 | `03_Technical/01_Database_Design.md` | 通过 | 主文档口径已统一 | 已确认 |
| 3 | 接口编号规范 | `03_Technical/03_Interface_Design.md` | 通过 | 维持 `IF-` 规则 | 已确认 |
| 1 | 系统名称一致性 | `docs/design/01_Overview/03_Summary_Design.md` | 通过 | 未发现“系统名称混用” | 已确认 |
| 2 | 数据库口径一致性 | `docs/design/03_Technical_Design/01_Database_Design.md` | 通过 | 主文档口径已统一 | 已确认 |
| 3 | 接口编号规范 | `docs/design/03_Technical_Design/03_Interface_Design.md` | 通过 | 维持 `IF-` 规则 | 已确认 |
| 4 | 主文档元数据 | 六个主文档 | 通过 | Front Matter 字段完整 | 已确认 |
| 5 | 目录索引完整性 | 七个一级目录 README | 通过 | 索引入口齐全 | 已确认 |
@ -35,7 +35,7 @@
| 命令 | 执行结果 | 备注 |
| --- | --- | --- |
| `make validate-file FILE=00_Management/09_AI_Document_Optimization_Plan.md` | 通过 | 规划文档验证 |
| `make validate-file FILE=docs/design/00_Management/09_AI_Document_Optimization_Plan.md` | 通过 | 规划文档验证 |
| `make check-links` | 通过 | 链接校验通过 |
| `make validate-mermaid` | 通过 | Mermaid 校验通过 |
| `scripts/check-ai-doc-governance.sh` | 通过 | AI 治理检查通过 |

View File

@ -2,7 +2,7 @@
## 目录用途
`00_Management/` 用于维护项目管理制度、执行台账、文档治理规则与 AI Agent 协作规范。
`docs/design/00_Management/` 用于维护项目管理制度、执行台账、文档治理规则与 AI Agent 协作规范。
## 权威文档(优先读取)

View File

@ -2,7 +2,7 @@
## 目录用途
`01_High_Level/` 用于维护系统总体设计、架构边界、子系统划分与概要设计主稿。
`docs/design/01_Overview/` 用于维护系统总体设计、架构边界、子系统划分与概要设计主稿。
## 权威文档

View File

@ -90,11 +90,11 @@
仓库当前以“管理—总体—详细—技术—附录归档”的方式组织,结构清晰,适合长期维护:
```text
00_Management/ 项目管理、进度、交付标准、编写指南
01_High_Level/ 系统概述、系统架构、概要设计、系统图谱
02_Detailed/ 详细设计、模块设计、CA 安装设计
03_Technical/ 数据库、表结构、接口、安全、部署、加密
04_Appendix/ 附录与 Archive 历史资料
docs/design/00_Management/ 项目管理、进度、交付标准、编写指南
docs/design/01_Overview/ 系统概述、系统架构、概要设计、系统图谱
docs/design/02_Detailed_Design/ 详细设计、模块设计、CA 安装设计
docs/design/03_Technical_Design/ 数据库、表结构、接口、安全、部署、加密
docs/design/04_Appendix/ 附录与 Archive 历史资料
assets/ 图片、模板等静态资源
docs/ 辅助说明、研究资料、后端映射与专题文档
scripts/ 导出、校验、处理脚本
@ -106,17 +106,17 @@ 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` | 部署设计主稿 |
| 总体概览 | `docs/design/01_Overview/01_System_Overview.md` | 系统背景、术语、参考资料等总览信息 |
| 概要设计 | `docs/design/01_Overview/03_Summary_Design.md` | 概要设计主稿 |
| 详细设计 | `docs/design/02_Detailed_Design/01_Detailed_Design.md` | 详细设计主稿 |
| 数据库设计 | `docs/design/03_Technical_Design/01_Database_Design.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` | 部署设计主稿 |
## Archive 与辅助资料的作用
`04_Appendix/Archive/` 当前主要承载以下内容:
`docs/design/04_Appendix/Archive/` 当前主要承载以下内容:
- 需求规格说明书
- 操作手册
@ -161,10 +161,10 @@ scripts/ 导出、校验、处理脚本
如果是第一次接手本项目,建议按以下顺序阅读:
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.md`、`03_Technical/03_Interface_Design.md`
2. 系统概述:`docs/design/01_Overview/01_System_Overview.md`
3. 概要设计主稿:`docs/design/01_Overview/03_Summary_Design.md`
4. 详细设计主稿:`docs/design/02_Detailed_Design/01_Detailed_Design.md`
5. 数据库与接口主稿:`docs/design/03_Technical_Design/01_Database_Design.md`、`docs/design/03_Technical_Design/03_Interface_Design.md`
6. 后端现状与表映射:`docs/guides/BACKEND_CURRENT_STATUS.md``docs/guides/BACKEND_TABLE_MAPPING.md`
7. Archive 中的需求、手册和数据字典资料

View File

@ -115,7 +115,7 @@ retrieval_priority: P0
## 编写目的
本文档用于指导福建水务营收系统的详细设计、开发实现、联调测试、部署上线及后续运维,是本项目详细设计阶段的统一主说明书。本文档以 `02_Detailed/01_Detailed_Design.md` 作为唯一主详设文件,吸收模块设计、数据库设计、接口设计、安全设计、部署设计以及报装电子签章专项设计中的可复用内容,形成可直接交付和实施使用的统一版本。
本文档用于指导福建水务营收系统的详细设计、开发实现、联调测试、部署上线及后续运维,是本项目详细设计阶段的统一主说明书。本文档以 `docs/design/02_Detailed_Design/01_Detailed_Design.md` 作为唯一主详设文件,吸收模块设计、数据库设计、接口设计、安全设计、部署设计以及报装电子签章专项设计中的可复用内容,形成可直接交付和实施使用的统一版本。
## 建设背景
@ -147,13 +147,13 @@ retrieval_priority: P0
## 参考资料
1. 《福建水务营收系统概要设计相关文档》
2. `02_Detailed/02_Module_Design.md`
3. `02_Detailed/03_CA_Installation_Design.md`
4. `03_Technical/01_Database_Design.md`
5. `03_Technical/02_Table_Specs.md`
6. `03_Technical/03_Interface_Design.md`
7. `03_Technical/04_Security_Design.md`
8. `03_Technical/05_Deployment_Design.md`
2. `docs/design/02_Detailed_Design/02_Module_Design.md`
3. `docs/design/02_Detailed_Design/03_CA_Installation_Design.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`
7. `docs/design/03_Technical_Design/04_Security_Design.md`
8. `docs/design/03_Technical_Design/05_Deployment_Design.md`
9. 福建水投相关业务操作手册及需求说明资料
# 系统总体设计

View File

@ -2,7 +2,7 @@
## 目录用途
`02_Detailed/` 用于维护系统详细设计、模块流程、规则约束与实施指导内容。
`docs/design/02_Detailed_Design/` 用于维护系统详细设计、模块流程、规则约束与实施指导内容。
## 权威文档

View File

@ -36,8 +36,8 @@ retrieval_priority: P0
本次接口整编遵循以下事实来源:
- `02_Detailed/01_Detailed_Design.md`
- `03_Technical/01_Database_Design.md`
- `docs/design/02_Detailed_Design/01_Detailed_Design.md`
- `docs/design/03_Technical_Design/01_Database_Design.md`
- `docs/guides/BACKEND_CURRENT_STATUS.md`
- `docs/guides/BACKEND_TABLE_MAPPING.md`
- `output/preview/福建水务营收系统整体架构图.html`

View File

@ -17,7 +17,7 @@
根据**等保测评要求**,用户的敏感个人信息(身份证、手机号、银行卡等)必须**加密存储**,否则无法通过安全检查。
```
```text
┌─────────────────────────────────────┐
│ 等保测评要求 │
└─────────────────────────────────────┘
@ -48,7 +48,7 @@
**"先加密存储,再建立索引"** —— 既保证安全,又保证能搜索
```
```text
┌─────────────────────────────────────────────────────────────────────┐
│ 技术方案整体架构 │
├─────────────────────────────────────────────────────────────────────┤
@ -93,7 +93,7 @@
### MyBatis-Plus 加密插件原理
```
```text
【自动加密/解密流程】
┌──────────┐ ┌──────────┐
@ -133,7 +133,7 @@
加密后的数据是乱码无法直接用SQL的 `LIKE` 查询。我们的解决方案是:**建立搜索索引**。
```
```text
┌───────────────────────────────────────────────────────────────────┐
│ 搜索索引设计思路 │
├───────────────────────────────────────────────────────────────────┤
@ -159,7 +159,7 @@
**场景:根据身份证号查询用户**
```
```text
用户输入身份证号
@ -184,7 +184,7 @@
### 表结构说明
```
```text
┌─────────────────────────────────────────────────────────────────────┐
│ 用户信息表 (user_info) │
├─────────────────────────────────────────────────────────────────────┤
@ -226,7 +226,7 @@
### 安全架构
```
```text
┌─────────────────────────────────────┐
│ 密钥管理中心 │
│ (独立安全存储) │
@ -262,7 +262,7 @@
### 实施步骤
```
```text
第1-2天 第3-5天 第6天 第7天
│ │ │ │
▼ ▼ ▼ ▼
@ -292,7 +292,7 @@
### 应急预案
```
```text
┌───────────────────────────────────────────────────────────────────┐
│ 应急处理流程 │
├───────────────────────────────────────────────────────────────────┤
@ -321,7 +321,7 @@
### 投入产出分析
```
```text
┌───────────────────────────────────────────────────────────────────┐
│ 投入产出分析 │
├───────────────────────────────────────────────────────────────────┤

View File

@ -2,7 +2,7 @@
## 目录用途
`03_Technical/` 用于维护数据库、接口、安全、部署等专题设计文档。
`docs/design/03_Technical_Design/` 用于维护数据库、接口、安全、部署等专题设计文档。
## 权威文档(主文档)

Some files were not shown because too many files have changed in this diff Show More