HaHafeng
e52020409c
- System architecture and design documentation - Business module docs (ASL/AIA/PKB/RVW/DC/SSA/ST) - ASL module complete design (quality assurance, tech selection) - Platform layer and common capabilities docs - Development standards and API specifications - Deployment and operations guides - Project management and milestone tracking - Architecture implementation reports - Documentation templates and guides
261 lines
10 KiB
Markdown
261 lines
10 KiB
Markdown
# 📚 壹证循AI科研平台 - 文档中心
|
||
|
||
> **文档版本：** v3.0
|
||
> **最后更新：** 2025-11-06
|
||
> **文档体系：** 三层架构 + 金字塔式快速上下文
|
||
|
||
---
|
||
|
||
## 🚀 快速开始
|
||
|
||
### 我是新AI实例，第一次对话
|
||
**必读：** [00-系统总体设计/[AI对接] 快速上下文](./00-系统总体设计/[AI对接]%20快速上下文.md)
|
||
**阅读时间：** 2分钟 | **Token消耗：** ~800 tokens
|
||
**价值：** 快速了解项目全貌、8个业务模块、技术栈、当前进度
|
||
|
||
---
|
||
|
||
### 我要开发具体模块
|
||
| 模块 | 快速上下文 | 阅读时间 | Token消耗 |
|
||
|------|-----------|---------|---------|
|
||
| **ASL-AI智能文献** ⭐ P0 | [ASL快速上下文](./03-业务模块/ASL-AI智能文献/[AI对接]%20ASL快速上下文.md) | 5分钟 | ~2000 |
|
||
| **LLM网关** ⭐ P0 | [LLM网关快速上下文](./02-通用能力层/01-LLM大模型网关/[AI对接]%20LLM网关快速上下文.md) | 5分钟 | ~2000 |
|
||
| **ADMIN运营管理端** P1 | [ADMIN快速上下文](./03-业务模块/ADMIN-运营管理端/[AI对接]%20ADMIN快速上下文.md) | 5分钟 | ~2000 |
|
||
|
||
---
|
||
|
||
### 我要了解整体架构
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [系统架构分层设计](./00-系统总体设计/01-系统架构分层设计.md) | 三层架构、8个业务模块 |
|
||
| [架构设计全景图](./00-系统总体设计/08-架构设计全景图.md) | 可视化架构图 |
|
||
| [数据库架构说明](./00-系统总体设计/03-数据库架构说明.md) | PostgreSQL + Schema隔离 |
|
||
|
||
---
|
||
|
||
## 📂 文档目录结构
|
||
|
||
```
|
||
docs/
|
||
├── 📖 00-系统总体设计/ # 总体架构、技术决策
|
||
│ ├── [AI对接] 快速上下文.md ⭐ L0总览（必读）
|
||
│ ├── 01-系统架构分层设计.md
|
||
│ ├── 02-文档体系重构方案.md
|
||
│ ├── 03-数据库架构说明.md
|
||
│ ├── 08-架构设计全景图.md
|
||
│ └── README.md
|
||
│
|
||
├── 📖 01-平台基础层/ # 平台基础设施（5个模块）
|
||
│ ├── [AI对接] 平台层快速上下文.md ⭐ L1层级
|
||
│ ├── 01-用户与权限中心(UAM)/
|
||
│ ├── 02-存储服务/
|
||
│ ├── 03-通知服务/
|
||
│ ├── 04-监控与日志/
|
||
│ ├── 05-系统配置/
|
||
│ └── README.md
|
||
│
|
||
├── 📖 02-通用能力层/ # 跨模块共享能力（5个能力）
|
||
│ ├── [AI对接] 通用能力快速上下文.md ⭐ L1层级
|
||
│ ├── 01-LLM大模型网关/ ⭐ P0优先级
|
||
│ │ ├── [AI对接] LLM网关快速上下文.md ⭐ L2模块级
|
||
│ │ └── README.md
|
||
│ ├── 02-文档处理引擎/
|
||
│ ├── 03-RAG引擎/
|
||
│ ├── 04-数据ETL引擎/
|
||
│ ├── 05-医学NLP引擎/
|
||
│ └── README.md
|
||
│
|
||
├── 📖 03-业务模块/ # 业务功能模块（8个模块）
|
||
│ ├── [AI对接] 业务模块快速上下文.md ⭐ L1层级
|
||
│ ├── ASL-AI智能文献/ ⭐ P0优先级
|
||
│ │ ├── [AI对接] ASL快速上下文.md ⭐ L2模块级
|
||
│ │ └── README.md
|
||
│ ├── ADMIN-运营管理端/ ⭐ P1优先级
|
||
│ │ ├── [AI对接] ADMIN快速上下文.md ⭐ L2模块级
|
||
│ │ └── README.md
|
||
│ ├── AIA-AI智能问答/ ✅ 已完成
|
||
│ ├── PKB-个人知识库/ ✅ 已完成
|
||
│ ├── RVW-稿件审查系统/ ✅ 已完成
|
||
│ ├── DC-数据清洗整理/
|
||
│ ├── SSA-智能统计分析/
|
||
│ ├── ST-统计分析工具/
|
||
│ └── README.md
|
||
│
|
||
├── 📖 04-开发规范/ # 编码规范、API规范
|
||
│ ├── 01-数据库设计规范.md
|
||
│ ├── 02-API设计规范.md
|
||
│ ├── 03-代码规范.md
|
||
│ ├── 04-Git提交规范.md
|
||
│ └── README.md
|
||
│
|
||
├── 📖 05-部署文档/ # 4种部署模式
|
||
│ ├── 01-云端SaaS部署/
|
||
│ ├── 02-独立产品包部署/
|
||
│ ├── 03-Electron单机版/
|
||
│ ├── 04-私有化部署/
|
||
│ └── README.md
|
||
│
|
||
├── 📖 06-测试文档/ # 测试计划、测试用例
|
||
│ └── README.md
|
||
│
|
||
├── 📖 07-运维文档/ # 运维手册、故障排查
|
||
│ └── README.md
|
||
│
|
||
├── 📖 08-项目管理/ # 开发计划、每日进度
|
||
│ ├── 01-整体开发计划/
|
||
│ ├── 02-里程碑规划/
|
||
│ └── 03-每日进度/
|
||
│
|
||
├── 📖 09-架构实施/ # 架构演进、重构计划
|
||
│ └── README.md
|
||
│
|
||
├── 📖 _templates/ # 文档模板
|
||
│ ├── [AI对接] 快速上下文-模板.md
|
||
│ ├── 模块README-模板.md
|
||
│ └── README.md
|
||
│
|
||
└── 📖 00-项目概述/ # 历史文档（待整理）
|
||
├── 现有系统技术摸底报告.md
|
||
├── 壹证循科技 AI科研产品需求文档.md
|
||
├── 壹证循科技AI科研产品 - 技术架构白皮书.md
|
||
└── AI智能文献PRD（1-3）.md
|
||
```
|
||
|
||
---
|
||
|
||
## 🎯 快速上下文体系（金字塔式）
|
||
|
||
### L0 - 总览（800 tokens，2分钟）
|
||
**目标：** 新AI实例快速了解项目全貌
|
||
**文档：** [00-系统总体设计/[AI对接] 快速上下文](./00-系统总体设计/[AI对接]%20快速上下文.md)
|
||
**包含：** 8个业务模块、技术栈、当前进度、依赖关系
|
||
|
||
### L1 - 层级（1500 tokens/篇，3分钟）
|
||
**目标：** 了解某一层的所有模块/能力
|
||
**文档：**
|
||
- [01-平台基础层/[AI对接] 平台层快速上下文](./01-平台基础层/[AI对接]%20平台层快速上下文.md)
|
||
- [02-通用能力层/[AI对接] 通用能力快速上下文](./02-通用能力层/[AI对接]%20通用能力快速上下文.md)
|
||
- [03-业务模块/[AI对接] 业务模块快速上下文](./03-业务模块/[AI对接]%20业务模块快速上下文.md)
|
||
|
||
### L2 - 模块级（2000 tokens/篇，5分钟）
|
||
**目标：** 深入了解具体模块的实现细节
|
||
**文档：**
|
||
- [ASL-AI智能文献/[AI对接] ASL快速上下文](./03-业务模块/ASL-AI智能文献/[AI对接]%20ASL快速上下文.md) ⭐ P0
|
||
- [LLM大模型网关/[AI对接] LLM网关快速上下文](./02-通用能力层/01-LLM大模型网关/[AI对接]%20LLM网关快速上下文.md) ⭐ P0
|
||
- [ADMIN-运营管理端/[AI对接] ADMIN快速上下文](./03-业务模块/ADMIN-运营管理端/[AI对接]%20ADMIN快速上下文.md) P1
|
||
|
||
---
|
||
|
||
## 📊 项目状态一览
|
||
|
||
### 当前阶段
|
||
🏗️ **架构设计完成，文档重构完成，准备ASL模块开发**
|
||
|
||
### 已完成模块（3个）
|
||
| 模块 | 状态 | 说明 |
|
||
|------|------|------|
|
||
| AIA-AI智能问答 | ✅ | 12个智能体、多轮对话 |
|
||
| PKB-个人知识库 | ✅ | RAG问答、智能引用 |
|
||
| RVW-稿件审查系统 | ✅ | 独立系统，可独立售卖 |
|
||
|
||
### 下一步开发（P0）
|
||
| 模块 | 优先级 | 预计时间 | 前置条件 |
|
||
|------|--------|---------|---------|
|
||
| **LLM大模型网关** | P0 | 3天 | 无 |
|
||
| **ASL-AI智能文献** | P0 | 3周 | LLM网关完成 |
|
||
|
||
---
|
||
|
||
## 🔍 常见场景导航
|
||
|
||
### 场景1：开发ASL模块（标题摘要初筛）
|
||
1. 阅读：[ASL快速上下文](./03-业务模块/ASL-AI智能文献/[AI对接]%20ASL快速上下文.md)（5分钟）
|
||
2. 阅读：[LLM网关快速上下文](./02-通用能力层/01-LLM大模型网关/[AI对接]%20LLM网关快速上下文.md)（5分钟）
|
||
3. 参考：`AI智能文献/` 目录下的详细PRD和技术设计文档
|
||
4. 开始开发
|
||
|
||
**Token消耗：** ~4000 tokens | **时间：** 10-15分钟
|
||
|
||
---
|
||
|
||
### 场景2：实现LLM网关
|
||
1. 阅读：[LLM网关快速上下文](./02-通用能力层/01-LLM大模型网关/[AI对接]%20LLM网关快速上下文.md)（5分钟）
|
||
2. 阅读：[平台层快速上下文](./01-平台基础层/[AI对接]%20平台层快速上下文.md) - 了解Feature Flag（3分钟）
|
||
3. 参考：API设计规范、数据库设计规范
|
||
4. 开始开发
|
||
|
||
**Token消耗：** ~3500 tokens | **时间：** 8-10分钟
|
||
|
||
---
|
||
|
||
### 场景3：了解整体架构设计
|
||
1. 阅读：[00-系统总体设计/[AI对接] 快速上下文](./00-系统总体设计/[AI对接]%20快速上下文.md)（2分钟）
|
||
2. 阅读：[系统架构分层设计](./00-系统总体设计/01-系统架构分层设计.md)（10分钟）
|
||
3. 阅读：[架构设计全景图](./00-系统总体设计/08-架构设计全景图.md)（5分钟）
|
||
4. 根据需要深入了解特定层级
|
||
|
||
**Token消耗：** ~5000 tokens | **时间：** 15-20分钟
|
||
|
||
---
|
||
|
||
### 场景4：修改数据库
|
||
1. 阅读：[数据库架构说明](./00-系统总体设计/03-数据库架构说明.md)
|
||
2. 参考：[04-开发规范/01-数据库设计规范](./04-开发规范/README.md)
|
||
3. 找到对应模块的数据库设计文档
|
||
4. 开始修改
|
||
|
||
---
|
||
|
||
## 📝 文档维护规则
|
||
|
||
### 1. 快速上下文文档
|
||
- ✅ 必须控制在指定Token范围内
|
||
- ✅ 包含关键信息和跳转链接
|
||
- ✅ 每次架构变更后及时更新
|
||
|
||
### 2. 详细设计文档
|
||
- ✅ 每个模块必须有README.md
|
||
- ✅ 复杂模块需要分多个子文档
|
||
- ✅ 使用统一的文档模板
|
||
|
||
### 3. 代码注释
|
||
- ✅ 核心逻辑必须有注释
|
||
- ✅ 复杂算法必须有文档说明
|
||
- ✅ API接口必须有JSDoc
|
||
|
||
---
|
||
|
||
## ⚠️ 重要提醒
|
||
|
||
### 文档优先级
|
||
1. ⭐⭐⭐⭐⭐ **快速上下文（L0、L1、L2）** - 必须保持更新
|
||
2. ⭐⭐⭐⭐ **架构设计文档** - 重要变更必须更新
|
||
3. ⭐⭐⭐ **模块README** - 每个模块必备
|
||
4. ⭐⭐ **详细设计文档** - 复杂模块需要
|
||
5. ⭐ **开发日志** - 记录关键决策
|
||
|
||
### Token消耗优化
|
||
**传统方式：** 阅读全部文档 → ~30,000 tokens → 1小时+
|
||
**快速上下文：** L0+L1+L2 → ~5,000 tokens → 10-15分钟
|
||
**节省：** 83%的Token + 75%的时间
|
||
|
||
---
|
||
|
||
## 🔗 外部资源
|
||
|
||
**代码仓库：** `D:\MyCursor\AIclinicalresearch\`
|
||
**数据库：** PostgreSQL (Docker, localhost:5432)
|
||
**Dify：** http://localhost (独立系统)
|
||
|
||
---
|
||
|
||
## 📞 联系方式
|
||
|
||
**技术架构师：** 负责架构设计和文档维护
|
||
**文档版本：** v3.0
|
||
**最后更新：** 2025-11-06
|
||
|
||
---
|
||
|
||
**🎯 下一步行动：** 开始ASL模块开发 + LLM网关实现（Week 2）
|