AIclinicalresearch/docs

AI科研助手 - 文档中心

🏠 导航

• ← 返回项目主页
• ⚙️ 后端开发指南
• 🎨 前端开发指南
• 🚀 快速启动指南

---

📚 文档导航

00-项目概述

• 产品需求文档(PRD) ⭐
• 技术架构总览 ⭐
• 设计文档完成总结

01-设计文档 ⭐ 核心

• 数据库设计文档 ⭐
• API设计规范 ⭐
• 用户端原型图 🎨
• 系统架构设计
• 接口设计详细说明

02-开发规范 ⭐ 核心

• 代码规范 ⭐
• Git提交规范
• 命名规范
• 目录结构规范

03-业务规则 ⭐ 核心

• 核心业务规则总览 ⭐
• 智能体管理规则
• 项目管理规则
• 知识库管理规则

04-开发计划 ⭐ 核心

• 开发里程碑 ⭐
• 详细开发计划

05-配置文档

• 智能体配置说明
• 模型配置说明
• Prompt编写指南

06-测试文档

• 测试计划
• 测试用例

07-部署文档

• 本地开发环境配置
• 测试环境部署
• 生产环境部署

08-参考资料

• Dify接入指南
• LobeChat组件参考
• 对话系统实现方案

---

🎯 文档使用指南

新人入门顺序

1. 阅读 00-项目概述/产品需求文档(PRD).md - 了解产品全貌
2. 查看 01-设计文档/用户端原型图.html - 体验产品交互
3. 阅读 00-项目概述/技术架构总览.md ⭐ - 快速了解技术方案
4. 阅读 01-设计文档/数据库设计文档.md - 理解数据结构
5. 阅读 01-设计文档/API设计规范.md - 掌握接口定义
6. 阅读 02-开发规范/代码规范.md - 遵守开发规范
7. 阅读 03-业务规则/核心业务规则总览.md - 理解业务逻辑
8. 阅读 04-开发计划/开发里程碑.md - 了解开发计划
9. 开始开发

开发前必读

• ⭐ 产品需求文档(PRD) - 了解产品需求
• ⭐ 技术架构总览 - 了解技术方案
• ⭐ 数据库设计文档 - 理解数据结构
• ⭐ API设计规范 - 掌握接口定义
• ⭐ 代码规范 - 遵守开发规范
• ⭐ 业务规则总览 - 理解业务逻辑

文档维护原则

1. 所有设计变更必须先更新文档
2. 每个功能模块开发前先完善对应业务规则文档
3. API变更需要同步更新接口文档
4. 保持文档与代码同步

---

文档版本： v1.0
创建日期： 2025-10-10
维护者： 开发团队