# 文档体系重构方案 > **文档版本?* v3.0 > **创建日期?* 2025-11-06 > **最后更新:** 2025-11-06 > **文档状态:** 待实? > **作者:** 技术架构师 > > **更新说明?* > - v3.0: 新增文档分层原则、快速上下文体系、详细执行计?> - v2.0: 新增运营管理端、多种部署方案、Monorepo架构相关文档 --- ## 📋 文档重构背景 ### 当前问题 **现有文档结构?* ``` AIclinicalresearch/docs/ ├── 00-项目概述/ ├── 01-设计文档/ ├── 02-开发规? ├── 03-业务规则/ ├── 04-开发计? ├── 05-每日进度/ └── AI智能文献/ ``` **存在的问题:** 1. ?**总体与模块混?*:系统总体设计与具体模块文档混在一?2. ?**层次不清?*:无法区分平台层、通用能力层、业务模块层 3. ?**模块文档分散**:AI智能文献有独立文件夹,其他模块没?4. ?**难以扩展**:新增模块时,文档结构混?5. ?**不支持独立销?*:无法快速打包某个模块的完整文档 6. ?**规范与设计混?*:数据库设计规范和具体设计文档放在一?7. ?**缺少快速上下文**:新AI对接时需要阅读大量文档,Token消耗高 8. ?**文档查找困难**:没有清晰的导航和分? --- ## 🎯 重构目标 ### 核心原则 1. ?**总体与模块分?*:系统总体设计独立于业务模?2. ?**层次清晰**:平台层、通用能力层、业务模块层分开 3. ?**模块完整**:每个模块有完整的文档结构(需求、设计、开发、测试、部署) 4. ?**易于扩展**:新增模块只需复制文档模板 5. ?**支持独立销?*:每个模块的文档可以独立打包 6. ?**规范与设计分?*:设计规范统一管理,具体设计按模块组织 7. ?**快速上下文优先**:每个层级都有快速上下文文档,降低AI对接成本 8. ?**金字塔式文档**:从简到详,按需深入 --- ## 🏗?新文档结构设? ### 总体结构 ``` AIclinicalresearch/ ├── docs/ ? ? ? ├── 📁 00-系统总体设计/ # 【新增】总体层面 ? ? ├── 00-核心问题解答.md # ?已创? ? ? ├── 01-系统架构分层设计.md # ?已创? ? ? ├── 02-文档体系重构方案.md # ?当前文档 ? ? ├── 03-数据库架构说?md # ?已创? ? ? ├── 04-运营管理端架构设?md # ?已创建(v2.0新增? ? ? ├── 05-Schema隔离方案与成本分?md # ?已创建(v2.0新增? ? ? ├── 06-模块独立部署与单机版方案.md # ?已创建(v2.0新增? ? ? ├── 07-总体需求文?PRD).md # ?待迁? ? ? ├── 08-技术架构白皮书.md # ?待迁? ? ? ├── 09-商业模式设计.md # ?待创? ? ? ├── 10-版本规划.md # ?待创? ? ? └── README.md # ?已创? ? ? ? ├── 📁 01-平台基础? # 【新增】平台层 ? ? ├── 01-用户与权限中?UAM)/ ? ? ├── 02-存储服务/ ? ? ├── 03-通知服务/ ? ? ├── 04-监控与日? ? ? ├── 05-系统配置/ ? ? └── README.md ? ? ? ├── 📁 02-通用能力? # 【新增】通用能力? ? ? ├── 01-LLM大模型网? # P0优先? ? ? ├── 02-文档处理引擎/ ? ? ├── 03-RAG引擎/ ? ? ├── 04-数据ETL引擎/ ? ? ├── 05-医学NLP引擎/ ? ? └── README.md ? ? ? ├── 📁 03-业务模块/ # 【新增】业务模块层 ? ? ? ? ? ├── 📁 AIA-AI智能问答/ # ?已完? ? ? ├── 📁 ASL-AI智能文献/ # ?下一步重? ? ? ├── 📁 PKB-个人知识? # ?已完? ? ? ├── 📁 DC-数据清洗整理/ # ?规划? ? ? ├── 📁 SSA-智能统计分析/ # ?规划? ? ? ├── 📁 ST-统计分析工具/ # ?规划? ? ? ├── 📁 RVW-稿件审查系统/ # ?独立系统 ? ? ├── 📁 ADMIN-运营管理? # ?v2.0新增(独立系统) ? ? ? ? ? └── README.md # 业务模块导航 ? ? ? ├── 📁 04-开发规? # 保留 ? ? ├── 代码规范.md ? ? ├── Git规范.md ? ? └── README.md ? ? ? ├── 📁 05-部署文档/ # 【扩展】部署相关(v2.0扩展? ? ? ├── 01-云端SaaS部署/ # ?v2.0扩展 ? ? ? ├── 01-完整平台部署.md ? ? ? ├── 02-微服务架构部?md ? ? ? ├── 03-K8s部署指南.md ? ? ? └── README.md ? ? ? ? ? ├── 02-独立产品包部? # ?v2.0新增 ? ? ? ├── 01-审稿系统独立部署.md ? ? ? ├── 02-AI文献系统独立部署.md ? ? ? ├── 03-Docker打包指南.md ? ? ? └── README.md ? ? ? ? ? ├── 03-Electron单机? # ?v2.0新增 ? ? ? ├── 01-单机版架构设?md ? ? ? ├── 02-打包配置指南.md ? ? ? ├── 03-跨平台适配.md ? ? ? ├── 04-自动更新方案.md ? ? ? └── README.md ? ? ? ? ? ├── 04-私有化部? ? ? ? ├── 01-Docker部署指南.md ? ? ? ├── 02-K3s轻量级部?md ? ? ? ├── 03-一键部署脚?md ? ? ? └── README.md ? ? ? ? ? └── README.md # 部署文档总导? ? ? ? ├── 📁 06-测试文档/ # 【新增? ? ? ├── 01-测试策略.md ? ? ├── 02-自动化测?md ? ? ├── 03-性能测试.md ? ? └── README.md ? ? ? ├── 📁 07-运维文档/ # 【新增? ? ? ├── 01-监控告警.md ? ? ├── 02-故障排查.md ? ? ├── 03-备份恢复.md ? ? └── README.md ? ? ? ├── 📁 08-项目管理/ # 【调整】项目管? ? ? ├── 01-整体开发计?md ? ? ├── 02-里程碑规?md ? ? ├── 03-每日进度/ # 保留原有每日进度 ? ? └── README.md ? ? ? ├── 📁 09-架构实施/ # ?v2.0新增 ? ? ├── 01-Monorepo架构设计/ ? ? ? ├── 01-Monorepo总体设计.md ? ? ? ├── 02-包管理策?md ? ? ? ├── 03-代码共享与复?md ? ? ? └── README.md ? ? ? ? ? ├── 02-产品打包方案/ ? ? ? ├── 01-独立产品打包流程.md ? ? ? ├── 02-依赖管理.md ? ? ? ├── 03-构建脚本.md ? ? ? └── README.md ? ? ? ? ? ├── 03-微服务拆? ? ? ? ├── 01-拆分策略.md ? ? ? ├── 02-服务间通信.md ? ? ? ├── 03-API网关配置.md ? ? ? └── README.md ? ? ? ? ? └── README.md ? ? ? └── README.md # 文档总导? ? └── backend/ └── frontend/ └── ... ``` --- ## 📐 文档分层原则 ?**v3.0新增** ### 核心问题:规范文?vs 具体设计文档 在文档重构过程中,我们发现一个关键问题:**数据库设计文档、API设计规范等文档应该放在哪里?** ### 解决方案:明确区分规范和设计 | 文档类型 | 位置 | 说明 | 示例 | |---------|------|------|------| | **全局规范** | `04-开发规?` | 告诉大家"怎么? | 数据库命名规范、API设计规范、代码规?| | **总体架构** | `00-系统总体设计/` | 整体视角 | Schema结构总览、部署架构、技术选型 | | **平台层设?* | `01-平台基础?` | 平台级服务的具体设计 | UAM的数据库设计、存储服务API | | **通用能力设计** | `02-通用能力?` | 可复用能力的具体设计 | LLM网关设计、文档处理设?| | **业务模块设计** | `03-业务模块/` | 各模块的具体设计 | ASL的数据库设计、AIA的API设计 | ### 示例:数据库设计文档处理 **当前问题?* `01-设计文档/数据库设计文?md`?319行)包含所有模块的表设? **重构方案?* 拆分?部分 ``` ┌─────────────────────────────────────────────────??1. 规范文档(告诉大家怎么设计? ?? 04-开发规?03-数据库设计规?md ?? - 表命名规范(模块前缀_表名? ?? - 字段类型规范(统一使用UUID? ?? - 索引设计原则 ?? - Schema隔离规范 ?└─────────────────────────────────────────────────? ┌─────────────────────────────────────────────────??2. 总体架构文档(整体视角) ?? 00-系统总体设计/03-数据库架构说?md (已有) ?? - Schema结构总览 ?? - 表关系图 ?? - 数据流向 ?└─────────────────────────────────────────────────? ┌─────────────────────────────────────────────────??3. 平台层数据库设计(平台级服务? ?? 01-平台基础?01-用户与权限中?UAM)/ ?? └─ 01-设计文档/02-数据库设?md ?? - platform_schema的表设计 ?? - users, roles, permissions? ?└─────────────────────────────────────────────────? ┌─────────────────────────────────────────────────??4. 各业务模块数据库设计(模块具体设计) ?? 03-业务模块/AIA-AI智能问答/01-设计文档/ ?? └─ 02-数据库设?md ?? - aia_schema的表设计 ?? ?? 03-业务模块/ASL-AI智能文献/01-设计文档/ ?? └─ 02-数据库设?md ?? - asl_schema的表设计 ?? ... ?└─────────────────────────────────────────────────?``` ### 示例:API设计规范处理 **重构方案?* ``` ┌─────────────────────────────────────────────────??规范文档(全局标准? ??04-开发规?02-API设计规范.md ??- RESTful规范(GET/POST/PUT/DELETE? ??- 错误码规范(200/400/500? ??- 认证规范(JWT Token? ??- 版本控制?api/v1/? ??- 分页规范(page/pageSize? ?└─────────────────────────────────────────────────? ┌─────────────────────────────────────────────────??各模块具体API设计(具体实现) ??03-业务模块/AIA-AI智能问答/01-设计文档/ ?? └─ 03-API设计.md ?? - POST /api/v1/projects ?? - GET /api/v1/conversations/:id ?? ... ?? ??03-业务模块/ASL-AI智能文献/01-设计文档/ ?? └─ 03-API设计.md ?? - POST /api/v1/literature/projects ?? - POST /api/v1/literature/screening ?? ... ?└─────────────────────────────────────────────────?``` ### 规范文档清单(`04-开发规?`? **需要创建的规范文档?* 1. ?**01-代码规范.md**(已有) - TypeScript代码规范 - 命名规范 - 注释规范 2. ?**02-API设计规范.md**(待创建? - RESTful规范 - 错误码规? - 认证规范 - 版本控制 - 分页规范 3. ?**03-数据库设计规?md**(待创建? - 表命名规? - 字段类型规范 - 索引设计原则 - Schema隔离规范 - 外键规范 4. ?**04-前端组件设计规范.md**(待创建? - 组件命名规范 - 目录结构规范 - Props设计规范 - 状态管理规? 5. ?**05-Git规范.md**(待创建? - 分支管理规范 - Commit Message规范 - PR规范 ### 好处 ?**规范统一**:所有模块遵循同一套规? ?**模块独立**:每个模块的设计文档完整、可独立 ?**易于维护**:修改某个模块不影响其他模块 ?**支持独立部署**:模块打包时带上完整文档 ?**新人友好**:先学规范,再看具体设计 --- ## 🚀 快速上下文体系 ?**v3.0新增** ### 核心问题:如何让新AI快速了解项目? **痛点?* - ?每次新对话都需要阅读大量文?- ?Token消耗高(完整文档可?K-10K tokens?- ?无法快速定位到具体模块 - ?缺少分层的上下文导航 ### 解决方案:金字塔式快速上下文 ``` ┌─────────────────────? ? 30秒上下文 (L0) ? ?1页,800 tokens ? 总体快速上下文 ? 所有对话必? └─────────────────────? ?需要更多细? ┌─────────────────────? ? 3分钟上下?(L1) ? ?3页,1500 tokens ? 层级快速上下文 ? 平台?能力?模块? └─────────────────────? ?需要开发细? ┌─────────────────────? ? 5分钟上下?(L2) ? ?5页,2000 tokens ? 模块快速上下文 ? 具体模块开? └─────────────────────? ?需要完整信? ┌─────────────────────? ? 完整文档体系 ? ?完整PRD和设计文? └─────────────────────?``` ### 快速上下文文档布局 ``` docs/ ? ├── 00-系统总体设计/ ? └── [AI对接] 快速上下文.md ?L0?0?2分钟?00 tokens? ? - 一句话描述项目 ? - 8个业务模块状? ? - 关键架构决策 ? - 快速跳转指? ? ├── 01-平台基础? ? ├── [AI对接] 平台层快速上下文.md ?L1?-3分钟?500 tokens? ? └── 01-用户与权限中?UAM)/ ? └── [AI对接] UAM快速上下文.md ?L2?-2分钟?00 tokens? ? ├── 02-通用能力? ? ├── [AI对接] 通用能力快速上下文.md ?L1?-3分钟?500 tokens? ? └── 01-LLM大模型网? ? └── [AI对接] LLM网关快速上下文.md ?L2?-2分钟?00 tokens? ? └── 03-业务模块/ ├── [AI对接] 业务模块快速上下文.md ?L1?-3分钟?500 tokens? └── ASL-AI智能文献/ └── [AI对接] ASL快速上下文.md ?L2?-5分钟?000 tokens?``` ### 快速上下文内容标准 #### L0 - 总体快速上下文(必读) **位置?* `00-系统总体设计/[AI对接] 快速上下文.md` **内容结构?* ```markdown # [AI对接] 快速上下文 > **阅读时间?* 2分钟 | **Token消耗:** ~800 tokens ## 一句话描述 [项目核心定位] ## 核心信息卡片 - 项目状?- 8个业务模块(优先级) - 关键架构决策 - 代码位置 - 核心依赖 ## 快速跳转(根据任务选择?- 开发ASL模块 ?[链接] - 了解架构设计 ?[链接] - 了解数据??[链接] ## 常见任务快速指?[任务类型 ?需要阅读的文档 ?Token消耗] ``` #### L1 - 层级快速上下文 **位置?* 各大层级根目? **内容?* 该层级的所有模块概览、依赖关系、快速导? #### L2 - 模块快速上下文 **位置?* 具体模块根目? **内容?* 模块定位、核心功能、技术架构、业务流程、开发计? ### 使用策略 **场景1:首次对话,完全不了解项?* ``` 阅读顺序?1. [必读] 00-系统总体设计/[AI对接] 快速上下文.md (~800 tokens?分钟) ?现在可以开始对话了 ``` **场景2:开发ASL模块** ``` 阅读顺序?1. [必读] 00-系统总体设计/[AI对接] 快速上下文.md (~800 tokens) 2. [必读] 03-业务模块/ASL-AI智能文献/[AI对接] ASL快速上下文.md (~2000 tokens) 3. [可选] 如果需要LLM网关细节 ?LLM网关快速上下文 (~800 tokens) 总计:~3600 tokens?-8分钟 ``` **场景3:架构讨?* ``` 阅读顺序?1. [必读] 00-系统总体设计/[AI对接] 快速上下文.md (~800 tokens) 2. [必读] 00-系统总体设计/08-架构设计全景?md (~3000 tokens) 3. [可选] 根据讨论方向选择具体文档 总计:~4000-8000 tokens?0-15分钟 ``` ### Token消耗对? | 方式 | Token消?| 阅读时间 | 覆盖范围 | |-----|----------|---------|---------| | **传统方式**(读完整PRD?| 5K-10K | 20-30分钟 | 单个模块 | | **快速上下文L0** | 800 | 2分钟 | 项目全貌 | | **快速上下文L0+L2** | 2.8K | 5-8分钟 | 项目+具体模块 | | **节省** | **50-70%** | **70-80%** | - | ### 实施要求 **在文档重构时,同步创建快速上下文?* 1. ?**L0 - 总体快速上下文**(已存在,需更新? - `00-系统总体设计/[AI对接] 快速上下文.md` 2. ?**L1 - 层级快速上下文**(新创建? - `01-平台基础?[AI对接] 平台层快速上下文.md` - `02-通用能力?[AI对接] 通用能力快速上下文.md` - `03-业务模块/[AI对接] 业务模块快速上下文.md` 3. ?**L2 - 模块快速上下文**(随模块创建? - ASL模块创建时,同步创建快速上下文 - LLM网关设计时,同步创建快速上下文 4. ?**标准模板**(创建模板文件) - `_templates/[AI对接] 模块快速上下文-模板.md` --- ## 📂 业务模块文档结构(标准模板) ### 每个业务模块的标准结? ``` 03-业务模块/ └── XXX-模块名称/ ? ├── 📁 00-项目概述/ ? ├── 00-模块导航.md # 模块内文档导? ? ├── 01-产品需求文?PRD).md # 产品需? ? ├── 02-核心功能清单.md # 功能列表 ? ├── 03-用户故事.md # 用户故事 ? ├── 04-非功能需?md # 性能、安全等 ? └── README.md ? ├── 📁 01-设计文档/ ? ├── 01-技术架构设?md # 模块技术架? ? ├── 02-数据库设?md # Schema、表结构 ? ├── 03-API设计.md # RESTful API ? ├── 04-前端组件设计.md # UI组件 ? ├── 05-AI模型集成设计.md # AI相关(如需要) ? ├── 06-UI原型/ # 原型? ? ? ├── xxx原型.html ? ? └── ... ? └── README.md ? ├── 📁 02-业务规则/ ? ├── 01-核心业务规则.md ? ├── 02-数据验证规则.md ? ├── 03-权限规则.md ? └── README.md ? ├── 📁 03-开发计? ? ├── 01-开发里程碑.md ? ├── 02-任务分解.md ? ├── 03-技术难点与风险.md ? └── README.md ? ├── 📁 04-测试文档/ ? ├── 01-测试计划.md ? ├── 02-测试用例.md ? ├── 03-测试报告.md ? └── README.md ? ├── 📁 05-部署文档/ ? ├── 01-部署指南.md ? ├── 02-配置说明.md ? ├── 03-常见问题.md ? └── README.md ? ├── 📁 06-开发进? # 可? ? ├── Week-01.md ? ├── Week-02.md ? └── README.md ? └── README.md # 模块总导?``` --- ## 🎯 具体模块文档规划 ### 1. AIA - AI智能问答模块 ?**已完?* **当前状态:** 功能已完成,需要补充文? **文档清单?* ``` 03-业务模块/AIA-AI智能问答/ ├── 00-项目概述/ ? ├── 01-产品需求文?PRD).md # ⚠️ 需要补? ? ├── 02-核心功能清单.md # ?可基于现有文档整? ? └── README.md ├── 01-设计文档/ ? ├── 01-技术架构设?md # ?可基于现有文档整? ? ├── 02-数据库设?md # ?已有(基于Prisma Schema? ? ├── 03-API设计.md # ?已有(基于API规范? ? └── 04-前端组件设计.md # ⚠️ 需要补? ├── 02-业务规则/ ? └── 01-核心业务规则.md # ⚠️ 需要补? ├── 03-开发计? ? ├── 01-开发里程碑.md # ?已完成(里程??.5? ? └── README.md └── README.md ``` **优先级:** P2(已完成,文档补充不急) --- ### 2. ASL - AI智能文献模块 ?**下一步重?* **当前状态:** 已有PRD和原型,即将开? **文档清单?* ``` 03-业务模块/ASL-AI智能文献/ ├── 00-项目概述/ ? ├── 01-产品需求文?PRD).md # ?已有?个PRD文档? ? ├── 02-核心功能清单.md # ?已有?大模块) ? ├── 03-用户故事.md # ⚠️ 需要补? ? └── README.md ├── 01-设计文档/ ? ├── 01-技术架构设?md # ?已有(系统架构设计) ? ├── 02-数据库设?md # ?已有(数据库设计? ? ├── 03-API设计.md # ?已有(API设计? ? ├── 04-前端组件设计.md # ?已有(前端组件设计) ? ├── 05-AI模型集成设计.md # ?已有(AI模型集成设计? ? └── 06-UI原型/ ? ├── 标题摘要初筛原型.html # ?已有 ? └── 全文复筛原型.html # ?已有 ├── 02-业务规则/ ? └── 01-核心业务规则.md # ⚠️ 需要补? ├── 03-开发计? ? ├── 01-开发里程碑.md # ?已有 ? ├── 02-任务分解.md # ?已有 ? └── README.md ├── 04-测试文档/ ? ├── 01-测试计划.md # ?已有 ? ├── 02-测试用例.md # ?已有(标题摘要初筛) ? └── README.md └── README.md ``` **优先级:** P0(下一步开发重点) **特点?* - ?文档最完整(已有AI智能文献/文件夹) - ?可以直接作为模板 - ⚠️ 需要调整结构(按新模板重新组织? --- ### 3. PKB - 个人知识库模??**已完?* **当前状态:** 功能已完成,需要补充文? **文档清单?* ``` 03-业务模块/PKB-个人知识? ├── 00-项目概述/ ? ├── 01-产品需求文?PRD).md # ⚠️ 需要补? ? └── README.md ├── 01-设计文档/ ? ├── 01-技术架构设?md # ⚠️ 需要补? ? ├── 02-数据库设?md # ?已有(基于Prisma Schema? ? ├── 03-API设计.md # ?已有(基于API规范? ? └── README.md └── README.md ``` **优先级:** P2(已完成,文档补充不急) --- ### 4. DC - 数据清洗整理模块 ?**规划?* **当前状态:** 未开发,需要完整设? **文档清单?* ``` 03-业务模块/DC-数据清洗整理/ ├── 00-项目概述/ ? ├── 01-产品需求文?PRD).md # ?待创? ? ├── 02-核心功能清单.md # ?待创? ? ├── 03-用户故事.md # ?待创? ? └── README.md ├── 01-设计文档/ ? ├── 01-技术架构设?md # ?待创? ? ├── 02-数据库设?md # ?待创? ? ├── 03-API设计.md # ?待创? ? ├── 04-前端组件设计.md # ?待创? ? ├── 05-ETL引擎设计.md # ?待创建(关键? ? ├── 06-医学NLP设计.md # ?待创建(关键? ? └── README.md ├── 02-业务规则/ ? └── 01-核心业务规则.md # ?待创? ├── 03-开发计? ? ├── 01-开发里程碑.md # ?待创? ? └── README.md └── README.md ``` **优先级:** P1(核心竞争力,ASL之后开发) --- ### 5. SSA - 智能统计分析模块 ?**规划?* **当前状态:** 未开发,需要完整设? **文档清单?* ``` 03-业务模块/SSA-智能统计分析/ ├── 00-项目概述/ ? ├── 01-产品需求文?PRD).md # ?待创? ? └── README.md ├── 01-设计文档/ ? ├── 01-技术架构设?md # ?待创? ? ├── 02-R语言集成设计.md # ?待创建(关键? ? ├── 03-数据库设?md # ?待创? ? └── README.md └── README.md ``` **优先级:** P2(需要R语言,有一定难度) --- ### 6. ST - 统计分析工具模块 ?**规划?* **当前状态:** 未开发,需要完整设? **文档清单?* ``` 03-业务模块/ST-统计分析工具/ ├── 00-项目概述/ ? ├── 01-产品需求文?PRD).md # ?待创? ? └── README.md ├── 01-设计文档/ ? ├── 01-技术架构设?md # ?待创? ? ├── 02-工具清单.md # ?待创建(100+工具? ? └── README.md └── README.md ``` **优先级:** P3(相对简单,可延后) --- ### 7. RVW - 稿件审查系统 ?**独立系统** **当前状态:** 核心功能已完成,需要独立规? **文档清单?* ``` 03-业务模块/RVW-稿件审查系统/ ├── 00-项目概述/ ? ├── 01-产品需求文?PRD).md # ?待创? ? ├── 02-独立系统规划.md # ?待创建(关键? ? ├── 03-商业模式设计.md # ?待创建(独立销售) ? └── README.md ├── 01-设计文档/ ? ├── 01-技术架构设?md # ⚠️ 需要补? ? ├── 02-数据库设?md # ?已有(基于Prisma Schema? ? ├── 03-审稿流程设计.md # ?待创? ? ├── 04-审稿人管理设?md # ?待创? ? └── README.md ├── 02-业务规则/ ? ├── 01-稿约规范性评估标?md # ?已有 ? ├── 02-方法学评估标?md # ?已有 ? └── README.md └── README.md ``` **优先级:** P1(独立系统,高商业价值) **特点?* - ?可以完全独立部署和销?- ?目标客户:期刊编辑部、出版社 - ?商业模式:按期刊订阅 --- ### 8. ADMIN - 运营管理??**v2.0新增(独立系统)** **定位?* 横跨所有层次的管理系统 **核心功能模块?5个)?* ``` P0(必须,阶段一): 1. 用户管理 2. Feature Flag管理(版本功能控制) 3. LLM模型管理 4. 系统配置管理 P1(重要,阶段二)?5. 智能体提示词管理 6. 监控与日?7. 数据统计与报?8. 成本分析与计? P2(有用,阶段三)?9. 租户管理(私有化部署?10. 公告与通知管理 11. 帮助文档管理 12. 反馈与工单管?13. 系统健康检?14. 数据库备份与恢复 15. 运营数据分析 ``` **文档清单?* ``` 03-业务模块/ADMIN-运营管理? ├── 00-项目概述/ ? ├── 01-产品需求文?PRD).md # ?待创? ? ├── 02-功能清单?5个模块).md # ?待创? ? ├── 03-权限体系设计.md # ?待创? ? └── README.md ├── 01-设计文档/ ? ├── 01-技术架构设?md # ?待创? ? ├── 02-数据库设?md # ?待创? ? ├── 03-API设计.md # ?待创? ? ├── 04-前端组件设计.md # ?待创? ? ├── 05-权限体系实现.md # ?待创? ? └── README.md ├── 02-业务规则/ ? ├── 01-权限规则.md # ?待创? ? ├── 02-审计规则.md # ?待创? ? └── README.md ├── 03-开发计? ? ├── 01-开发里程碑.md # ?待创? ? ├── 02-任务分解(按阶段?md # ?待创? ? └── README.md └── README.md ``` **优先级:** P1(商业模式基础? **技术选型?* - 前端:React + Ant Design Pro - 后端:Node.js + Fastify - 数据库:PostgreSQL(admin_schema? **部署方式?* - 独立域名:`https://admin.yizhengxun.com` - 独立前端应用 - 独立后端API **实施阶段?* - 阶段一?-2个月):P0功能 - 阶段二(1-2个月):P1功能 - 阶段三(1-2个月):P2功能 --- ## 🔄 文档迁移计划 ### 第一阶段:创建新结构?-2天) **Step 1:创建总体文件?* ```bash mkdir -p "00-系统总体设计" mkdir -p "01-平台基础? mkdir -p "02-通用能力? mkdir -p "03-业务模块" ``` **Step 2:移动现有文档(保留原文件,先复制)** ``` # 总体文档 00-项目概述/ ?00-系统总体设计/ - 壹证循科技 AI科研产品需求文?md ?03-总体需求文?PRD).md - 壹证循科技AI科研产品 - 技术架构白皮书.md ?04-技术架构白皮书.md - 技术架构总览.md ?05-技术架构总览.md(作为补充) # AI智能文献模块 AI智能文献/ ?03-业务模块/ASL-AI智能文献/ (调整内部结构,按新模板组织? # 稿件审查评估标准 docs/稿件方法学评估标?txt ?03-业务模块/RVW-稿件审查系统/02-业务规则/ docs/稿约规范性评估标?txt ?03-业务模块/RVW-稿件审查系统/02-业务规则/ ``` --- ### 第二阶段:补充关键文档(按优先级? **P0文档(本周内):** 1. ?00-系统总体设计/01-系统架构分层设计.md(已完成?2. ?00-系统总体设计/02-文档体系重构方案.md(当前文档) 3. ⚠️ 02-通用能力?01-LLM大模型网?01-设计文档.md 4. ⚠️ 03-业务模块/ASL-AI智能文献/(调整结构) **P1文档(本月内):** 5. ⚠️ 03-业务模块/RVW-稿件审查系统/00-项目概述/02-独立系统规划.md 6. ⚠️ 03-业务模块/DC-数据清洗整理/00-项目概述/01-产品需求文?PRD).md 7. ⚠️ 01-平台基础?01-用户与权限中?UAM)/01-Feature-Flag设计.md **P2文档(下月)?* 8. 其他模块的PRD和设计文? --- ### 第三阶段:清理旧文档(迁移完成后? **策略?* - ?保留原文档一段时间(1个月?- ?在原位置添加README,指向新位置 - ?确认新文档无问题后,删除旧文? **示例README(原位置):** ```markdown # 📣 文档已迁? 本文档已迁移到新位置,请访问?- [00-系统总体设计](../00-系统总体设计/README.md) 旧文档将?025?2月后删除?``` --- ## 📊 文档迁移矩阵 | 原位?| 新位?| 状?| 优先?| |-------|-------|------|--------| | `AI智能文献/` | `03-业务模块/ASL-AI智能文献/` | ?待迁?| P0 | | `壹证循科技 AI科研产品需求文?md` | `00-系统总体设计/03-总体需求文?PRD).md` | ?待迁?| P0 | | `壹证循科技AI科研产品 - 技术架构白皮书.md` | `00-系统总体设计/04-技术架构白皮书.md` | ?待迁?| P0 | | `稿件方法学评估标?txt` | `03-业务模块/RVW-稿件审查系统/02-业务规则/` | ?待迁?| P1 | | `稿约规范性评估标?txt` | `03-业务模块/RVW-稿件审查系统/02-业务规则/` | ?待迁?| P1 | | `04-开发计?开发里程碑.md` | `08-项目管理/02-里程碑规?md` | ?待迁?| P2 | | `05-每日进度/` | `08-项目管理/03-每日进度/` | ?待迁?| P2 | --- ## ?迁移验收标准 ### 结构验收 - ?所有总体文档都在`00-系统总体设计/` - ?所有业务模块都在`03-业务模块/`下,且结构一?- ?每个模块都有完整的README导航 - ?文档层次清晰,无混杂 ### 内容验收 - ?所有文档内的内部链接已更新 - ?所有文档的引用路径已更?- ?所有图片、原型图路径已更? ### 可用性验?- ?可以快速定位任何一个文?- ?新增模块时,可以复制模板快速创?- ?某个模块的文档可以独立打包(如审稿系统) --- ## 🎯 总结 ### 重构后的核心优势 **1. 总体与模块分?* ``` 总体设计?0-系统总体设计/): - 面向整体产品战略 - 面向技术架构师 - 更新频率低,稳定性高 业务模块?3-业务模块/): - 面向具体功能开?- 面向开发团?- 更新频率高,独立演进 ``` **2. 层次清晰** ``` 平台层(01-平台基础?):所有模块的地基 通用能力层(02-通用能力?):跨模块共享能?业务模块层(03-业务模块/):独立产品单元 ``` **3. 支持独立销?* ``` 独立打包某个模块的完整文档: - ASL(AI智能文献)→ 独立产品文档?- RVW(稿件审查)?独立产品文档?- DC(数据清洗)?独立产品文档?``` **4. 易于扩展** ``` 新增模块?1. 复制模块模板 2. 填充PRD和设计文?3. 开始开?``` --- **下一步行动:** 1. ?创建新文件夹结构 2. ⚠️ 迁移ASL模块文档(P0?3. ⚠️ 补充LLM网关设计文档(P0?4. ⚠️ 补充RVW独立系统规划(P1? --- ## 📊 v2.0 更新总结 ### 新增核心内容 **1. 运营管理端(ADMIN?* ?**重要新增** - 新增?个业务模块:运营管理?- 15个核心功能模块(用户管理、Feature Flag、LLM模型管理等) - 独立的文档结构和实施计划 - 详见:`04-运营管理端架构设?md` **2. 多种部署方案** ⭐⭐?**重要扩展** - **云端SaaS部署**(扩展):完整平台部署、微服务架构 - **独立产品包部?*(新增):审稿系统、AI文献系统独立打包 - **Electron单机?*(新增):完全离线、本地SQLite - **私有化部?*(保留):Docker、K3s轻量级部? **3. 架构实施文档** ⭐⭐ **新增** - **Monorepo架构设计**:包管理、代码共享与复用 - **产品打包方案**:独立产品打包流程、依赖管?- **微服务拆?*:拆分策略、服务间通信、API网关 **4. 系统总体设计文档** ⭐⭐?**核心扩展** - `03-数据库架构说?md`:Docker部署、两个独立数据库对比 - `05-Schema隔离方案与成本分?md`:逻辑隔离 vs 物理隔离、改造成?- `06-模块独立部署与单机版方案.md`:完整打包、共享服务、Electron架构 ### 文档结构变化 **00-系统总体设计/ - 新增文档?* ``` ?03-数据库架构说?md ?04-运营管理端架构设?md ?05-Schema隔离方案与成本分?md ?06-模块独立部署与单机版方案.md ``` **03-业务模块/ - 新增模块?* ``` ?ADMIN-运营管理?(第8个模块) ``` **05-部署文档/ - 扩展结构?* ``` ?02-独立产品包部?(新增) ?03-Electron单机?(新增) ``` **09-架构实施/ - 新增文件夹:** ``` ?01-Monorepo架构设计/ ?02-产品打包方案/ ?03-微服务拆? ``` ### 关键技术决? **1. 模块独立部署方案?* - ?方案一:完整打包(独立产品?- ?方案二:共享服务(平台内模块? **2. Electron单机版:** - ?前端代码复用?0%+ - ?后端代码复用?0%+ - ?只需修改:API调用层、数据库(SQLite? **3. Schema隔离?* - ?现在做:1周,成本最?- ⚠️ 未来做:3-5周,成本5? ### 实施优先? **P0(已完成):** - ?系统架构分层设计 - ?数据库架构说?- ?运营管理端架构设?- ?Schema隔离方案 - ?模块独立部署方案 - ?文档体系重构方案v2.0 **P1(本周)?* - ?创建新文件夹结构 - ?迁移ASL模块文档 - ?LLM网关详细设计 - ?Schema隔离实施(可选) **P2(本月)?* - ?补充运营管理端详细文?- ?补充部署文档 - ?补充Monorepo架构文档 **P3(下月)?* - ?迁移其他模块文档 - ?补充测试和运维文? --- ## 📅 文档重构计划 v3.0 ?**详细执行计划** ### 执行时间估算 | 阶段 | 任务 | 预计时间 | 累计时间 | |-----|------|---------|---------| | **阶段一** | 创建目录结构 + 快速上下文模板 | 1小时 | 1小时 | | **阶段?* | 迁移和整理现有文?| 3小时 | 4小时 | | **阶段?* | 创建业务模块基础文档 + 快速上下文 | 2小时 | 6小时 | | **阶段?* | 创建总导航文?+ 规范文档 | 1.5小时 | 7.5小时 | | **阶段?* | 清理和验?+ 更新链接 | 1小时 | 8.5小时 | | **总计** | - | **8.5小时** | - | --- ### 🎯 阶段一:创建目录结构(1小时? #### 1.1 创建所有目录框? ```bash # 平台基础?01-平台基础? ├── 01-用户与权限中?UAM)/01-设计文档/ ├── 02-存储服务/01-设计文档/ ├── 03-通知服务/01-设计文档/ ├── 04-监控与日?01-设计文档/ └── 05-系统配置/01-设计文档/ # 通用能力?02-通用能力? ├── 01-LLM大模型网?01-设计文档/ ├── 02-文档处理引擎/01-设计文档/ ├── 03-RAG引擎/01-设计文档/ ├── 04-数据ETL引擎/01-设计文档/ └── 05-医学NLP引擎/01-设计文档/ # 业务模块?个模块) 03-业务模块/ ├── AIA-AI智能问答/ ├── ASL-AI智能文献/ ├── PKB-个人知识? ├── DC-数据清洗整理/ ├── SSA-智能统计分析/ ├── ST-统计分析工具/ ├── RVW-稿件审查系统/ └── ADMIN-运营管理? # 其他目录 04-开发规? 05-部署文档/ ├── 01-云端SaaS部署/ ├── 02-独立产品包部? ├── 03-Electron单机? └── 04-私有化部? 06-测试文档/ 07-运维文档/ 08-项目管理/ ├── 01-整体开发计? ├── 02-里程碑规? └── 03-每日进度/ 09-架构实施/ ├── 01-Monorepo架构设计/ ├── 02-产品打包方案/ └── 03-微服务拆? _templates/(模板文件夹?``` #### 1.2 创建快速上下文模板 **创建文件?* `_templates/[AI对接] 快速上下文-模板.md` **内容?* 标准的快速上下文模板,包含必填字段说? --- ### 🎯 阶段二:迁移和整理现有文档(3小时? #### 2.1 处理 `00-项目概述/` 文档?0分钟? | 文件?| 处理方式 | 目标位置 | |-------|---------|---------| | 壹证循科技 AI科研产品需求文?md | ?迁移 | `00-系统总体设计/09-总体需求文?PRD).md` | | 壹证循科技AI科研产品 - 技术架构白皮书.md | ?迁移 | `00-系统总体设计/10-技术架构白皮书.md` | | 现有系统技术摸底报?md | ?保留 | 原位置(重要参考) | | AI智能文献PRD?-3?md | ?迁移 | `03-业务模块/ASL-AI智能文献/00-项目概述/` | | 产品需求文?PRD).md | ⚠️ 审查合并 | 可能与总体PRD重复 | | 技术架构总览.md | ⚠️ 审查 | 可能与白皮书重复 | | 系统总体架构设计.md | ⚠️ 审查 | 可能与架构分层重?| **操作?* 1. 先审查重复文档,确定保留版本 2. 迁移文件(复制,不删除) 3. 在原位置创建迁移说明 #### 2.2 处理 `01-设计文档/` 文档?小时? **核心任务:拆分数据库设计文档?319行)** | 原文?| 拆分方式 | 目标位置 | |-------|---------|---------| | 数据库设计文?md | 提取规范部分 | `04-开发规?03-数据库设计规?md` | | | 提取总体架构部分 | 补充?`00-系统总体设计/03-数据库架构说?md` | | | 提取平台层表设计 | `01-平台基础?01-用户与权限中?UAM)/01-设计文档/02-数据库设?md` | | | 提取AIA模块表设?| `03-业务模块/AIA-AI智能问答/01-设计文档/02-数据库设?md` | | | 提取PKB模块表设?| `03-业务模块/PKB-个人知识?01-设计文档/02-数据库设?md` | | | 提取RVW模块表设?| `03-业务模块/RVW-稿件审查系统/01-设计文档/02-数据库设?md` | | 原文?| 处理方式 | 目标位置 | |-------|---------|---------| | API设计规范.md | 拆分 | `04-开发规?02-API设计规范.md`(规范) + 各模块API设计 | | 平台前端架构设计/ | 迁移 | `01-平台基础?06-前端架构/` | | AI智能文献原型.html?个) | 迁移 | `03-业务模块/ASL-AI智能文献/01-设计文档/07-UI设计/` | #### 2.3 处理 `AI智能文献/` 目录?小时? **操作:整体迁移并调整结构** ``` AI智能文献/ ?03-业务模块/ASL-AI智能文献/ 调整后的结构?ASL-AI智能文献/ ├── [AI对接] ASL快速上下文.md # ?新建 ├── 00-项目概述/ ? ├── 01-产品需求文?PRD).md # 合并3个PRD ? ├── 02-核心功能清单.md ? ├── 03-用户故事和验收标?md ? └── 04-非功能性需?md ├── 01-设计文档/ ? ├── 01-系统架构设计.md ? ├── 02-数据库设?md ? ├── 03-API设计.md ? ├── 04-前端组件设计.md ? ├── 05-AI模型集成设计.md ? ├── 06-文件处理设计.md ? └── 07-UI设计/ ? ├── 标题摘要初筛UI设计.md ? ├── 全文复筛UI设计.md ? ├── 标题摘要初筛原型.html ? └── 全文复筛原型.html ├── 02-业务规则/ ? └── 01-核心业务规则.md ├── 03-开发计? ? ├── 01-开发里程碑.md ? └── 02-任务分解.md ├── 04-测试文档/ ? ├── 01-测试计划.md ? └── 02-标题摘要初筛测试用例.md └── README.md ``` #### 2.4 处理 `04-开发计?` ?`05-每日进度/`?0分钟? ``` 04-开发计? ?08-项目管理/01-整体开发计? 05-每日进度/ ?08-项目管理/03-每日进度/ 同时提取里程碑文档到?08-项目管理/02-里程碑规? ├── 里程?-MVP完成总结.md ├── 里程?.5-RAG优化完成.md └── README.md ``` #### 2.5 处理稿件审查相关?0分钟? ``` 稿件方法学评估标?txt ?03-业务模块/RVW-稿件审查系统/02-业务规则/01-方法学评估标?md 稿约规范性评估标?txt ?03-业务模块/RVW-稿件审查系统/02-业务规则/02-稿约规范性评估标?md ``` --- ### 🎯 阶段三:创建业务模块基础文档 + 快速上下文?小时? #### 3.1 创建AIA模块文档?0分钟? **任务?* 1. ?创建模块目录结构 2. ?创建 `[AI对接] AIA快速上下文.md`(根据模板) 3. ?从现有代码和Prisma Schema提取数据库设?4. ?整理核心功能清单 5. ?创建README导航 **目录结构?* ``` AIA-AI智能问答/ ├── [AI对接] AIA快速上下文.md # ?新建 ├── 00-项目概述/ ? ├── 01-功能清单.md # 基于现有功能整理 ? └── README.md ├── 01-设计文档/ ? ├── 01-智能体配置系?md # 基于现有代码整理 ? ├── 02-数据库设?md # 提取Prisma Schema ? ├── 03-API设计.md # 提取现有API ? └── README.md └── README.md ``` #### 3.2 创建PKB模块文档?0分钟? **类似AIA模块,提取现有功能和设计** #### 3.3 创建RVW模块文档?0分钟? **包含稿件审查评估标准** #### 3.4 创建DC、SSA、ST、ADMIN空模板(30分钟? **每个模块创建?* ``` 模块? ├── [AI对接] 快速上下文.md(标记为待完善) ├── 00-项目概述/README.md ├── 01-设计文档/README.md └── README.md ``` --- ### 🎯 阶段四:创建总导航文?+ 规范文档?.5小时? #### 4.1 创建规范文档?小时? **需要创建:** 1. **02-API设计规范.md** - 从现有代码中提取RESTful规范 - 错误码规? - 认证规范(JWT? - 分页规范 2. **03-数据库设计规?md** - 从现有Prisma Schema中提取命名规? - 字段类型规范 - 索引规范 - Schema隔离规范 3. **04-前端组件设计规范.md** - 从现有前端代码中提取规范 4. **05-Git规范.md** - Commit Message规范 - 分支管理规范 #### 4.2 创建README导航?0分钟? **需要创?更新的README?* 1. ?`docs/README.md` - 总导航(更新?2. ?`01-平台基础?README.md` 3. ?`01-平台基础?[AI对接] 平台层快速上下文.md` 4. ?`02-通用能力?README.md` 5. ?`02-通用能力?[AI对接] 通用能力快速上下文.md` 6. ?`03-业务模块/README.md` 7. ?`03-业务模块/[AI对接] 业务模块快速上下文.md` 8. ?`04-开发规?README.md` 9. ?`05-部署文档/README.md` 10. ?`08-项目管理/README.md` --- ### 🎯 阶段五:清理和验证(1小时? #### 5.1 创建迁移说明?0分钟? **在所有迁移文件的原位置创建:** `_MIGRATED.md` ```markdown # 📣 文档已迁? 本文档已迁移到新位置?- [新位置链接](../新路?文档?md) **迁移日期?* 2025-11-06 **旧文档将在:** 2025-12-06 删除 --- **新文档结构说明:** [简要说明为什么迁移,新结构的好处] ``` #### 5.2 验证清单?0分钟? - [ ] 所有文档链接已更新 - [ ] 图片路径已更新(相对路径?- [ ] README导航完整且链接有?- [ ] 无死链接 - [ ] 每个模块都有快速上下文 - [ ] 文档层次清晰,符合三层架? #### 5.3 生成文档地图?0分钟? **创建?* `docs/[文档地图] 完整导航.md` **内容?* 树形结构展示所有文档及其用途,方便查找 --- ## ?关键决策确认 ### 需要您确认的问题: #### 1. 重复文档处理 **问题?* 以下文档可能重复,如何处理? | 文档A | 文档B | 建议 | 您的决定 | |------|------|------|---------| | 00-项目概述/产品需求文?PRD).md | 壹证循科技 AI科研产品需求文?md | 审查后保留更完整?| _________ | | 00-项目概述/系统总体架构设计.md | 00-系统总体设计/01-系统架构分层设计.md | 保留新版?| _________ | | 00-项目概述/技术架构总览.md | 壹证循科技AI科研产品 - 技术架构白皮书.md | 审查后决?| _________ | **您的决定?* - [ ] 选项A:自动保留更新的版本 - [ ] 选项B:我来手动审查每个重复文?- [ ] 选项C:都保留,标记为不同版本 #### 2. 旧文档删除策? **您的决定?* - [ ] 选项A:迁移后立即删除原文件(激进) - [ ] 选项B:保?个月,创建迁移说明(稳妥??推荐 - [ ] 选项C:移动到 `docs/_archived/` 存档(保守) #### 3. AI智能文献PRD合并 **当前?* 3个独立PRD文档(产品概览、初筛与复筛、提取与分析? **您的决定?* - [ ] 选项A:合并为1个完整PRD ?推荐 - [ ] 选项B:保持独立,按章节组? #### 4. 数据库设计文档拆? **当前?* `01-设计文档/数据库设计文?md`?319行) **您的决定?* - [ ] 选项A:自动拆分(AI辅助??推荐 - [ ] 选项B:手动拆分(精确但耗时?- [ ] 选项C:暂不拆分,标记为待处理 #### 5. 执行方式 **您的决定?* - [ ] 选项A:分批执行(5批,每批1-2小时)⭐ 推荐 - [ ] 选项B:一次性全部执行(8.5小时连续? --- ## 📊 v3.0 完成标志 ### 文档完整?- ?8个业务模块(含运营管理端?- ?4种部署方案(云端、独立包、单机版、私有化?- ?3层架构(平台层、能力层、业务层?- ?**规范与设计分?*(规范在04-开发规??- ?**快速上下文体系**(L0/L1/L2三级?- ?**金字塔式文档**(从简到详? ### 可操作?- ?每个模块可独立打包和部署 - ?每个模块有完整文档(需求、设计、开发、测试、部署) - ?新增模块可复制模板快速创?- ?**快速上下文导航**(新AI 2分钟了解项目?- ?**分层查找文档**(规?总体/模块? ### 商业价?- ?支持模块独立销售(审稿系统、AI文献等) - ?支持多种部署模式(满足不同客户需求) - ?支持灵活的商业模式(订阅制、一次性License、模块化售卖?- ?**降低AI对接成本**(Token消耗减?0-70%?- ?**提升开发效?*(规范统一,查找快速) --- ## 🚀 立即开? **请您回复确认?* 1. **是否认可整体计划?* - [ ] 是,开始执? - [ ] 否,需要调整:___________ 2. **关键决策确认?* - 重复文档处理:选项 _____ - 旧文档删除策略:选项 _____ - PRD合并:选项 _____ - 数据库文档拆分:选项 _____ - 执行方式:选项 _____ 3. **是否立即开始第1批操作?** - [ ] 是,立即开始(创建目录结构 + 模板? - [ ] 否,等待进一步确? --- **最后更新:** 2025-11-06 v3.0 **维护人:** 技术架构师 --- **下一步行动:** 等待您的确认后,立即开始执行文档重构!🚀