Develop/AIclinicalresearch
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
dbca1615b54d95363de5ebead0a04f1883c294e5
AIclinicalresearch/docs/03-业务模块/Redcap/00-模块概览/00-REDCap模块文档导航.md
HaHafeng dbca1615b5 docs(redcap): 重构REDCap文档体系并创建Docker部署操作手册 
核心成果:
 创建REDCap模块文档体系（4个分类目录）
 完成《REDCap Docker部署操作手册》- 最核心文档
 梳理从0到1的完整部署流程
 明确Docker文件的可复用性

文档体系:
- 00-模块概览/     系统介绍、方案设计、决策报告
- 01-部署与配置/   部署手册、问题排查（核心）
- 02-系统配置与运维/ 日常管理（规划中）
- 03-API对接与开发/ API开发、二次开发
- 04-参考资料/     旧版文档存档

核心文档:
 10-REDCap_Docker部署操作手册.md（最重要）
  - 完整的从0到1部署流程
  - Docker文件复用说明和可复用性分析
  - 3种环境差异配置（本地/ECS/医院）
  - 5大常见问题与解决方案
  - 部署检查清单
  - 日常维护命令

 13-部署问题排查手册.md
  - 基于实际踩坑经验
  - ERR_CONTENT_DECODING_FAILED
  - CRLF污染问题
  - Base URL配置错误
  - MySQL连接问题

Docker文件可复用性:
 100%可复用（无需修改）:
  - Dockerfile.redcap
  - docker-entrypoint.sh
  - config/php/php.ini
  - .gitattributes

 需根据环境调整:
  - docker-compose.yml（端口、卷路径）
  - config/apache/redcap.conf（域名）
  - config/database.php（数据库连接）

文档重组:
- 移动文档到对应分类目录
- 重命名为标准格式（数字前缀）
- 旧版文档归档到参考资料
- 创建README快速入口

下一步:
- Day 2: 开发REDCap API Adapter
- 创建API使用指南
- 创建对接设计文档
2026-01-02 10:17:00 +08:00

6.3 KiB
Raw Blame History

REDCap模块文档导航

最后更新： 2026-01-02
模块类型： 第三方系统集成与二次开发
当前状态： 本地Docker环境已部署，API Adapter开发中

📚 文档体系说明

REDCap是一个成熟的第三方EDC（电子数据采集）系统，本模块的工作重点是：

  1. 部署与配置：在不同环境（开发/生产/医院）部署REDCap
  2. API对接：通过REDCap API与IIT Manager Agent集成
  3. 运维管理：日常维护、备份、升级

因此，文档架构与自研模块（ASL、DC）不同，更侧重部署与集成。

📖 文档目录

1️⃣ 系统概览与决策

01-REDCap系统介绍与选型说明.md

  • REDCap是什么？
  • 为什么选择REDCap？
  • REDCap的核心功能
  • REDCap在IIT Manager中的角色

02-REDCap对接总体方案.md ✅

  • 技术架构设计
  • API对接方案
  • 数据流转方案
  • 安全性设计

03-REDCap对接风险评估与技术挑战分析.md ✅

  • 技术风险评估
  • 实施难度分析
  • 替代方案对比
  • 最终决策建议

04-生产环境部署决策报告_ECS_vs_SAE.md ✅

  • ECS vs SAE深度对比
  • 成本分析
  • 技术可行性
  • 最终选型：ECS

2️⃣ 部署与配置

10-本地开发环境部署完全指南.md ⭐

  • 快速开始（适合首次部署）
  • Docker环境准备
  • 一键部署脚本使用
  • 初始化配置
  • 验证测试
  • 关键参考文档！

11-生产环境部署完全指南_阿里云ECS.md ⭐

  • ECS服务器配置
  • Docker镜像构建与推送
  • RDS MySQL配置
  • 域名与SSL证书
  • 安全组与防火墙
  • 生产环境检查清单
  • 生产部署必读！

12-医院私有化部署指南.md 🏥

  • 医院服务器环境要求
  • 内网部署方案
  • 数据安全与合规
  • 技术支持与培训

13-部署问题排查手册.md 🔧

  • 常见部署问题
  • 错误日志分析
  • 问题解决记录
  • 预防措施

3️⃣ 配置与管理

20-REDCap系统配置手册.md

  • 基础配置（Base URL、邮件服务等）
  • 用户与权限管理
  • 项目创建与配置
  • 数据字典设计
  • 表单设计

21-REDCap日常运维手册.md

  • 日常维护任务
  • 备份与恢复
  • 性能监控
  • 日志管理
  • 故障处理流程

22-REDCap升级指南.md

  • 版本升级流程
  • 数据库迁移
  • 兼容性测试
  • 回滚方案

4️⃣ API对接与开发

30-REDCap_API使用指南.md

  • REDCap API概述
  • API Token获取
  • 常用API接口
  • 示例代码

31-IIT_Manager与REDCap对接设计.md

  • 数据流转设计
  • API Adapter架构
  • 接口设计
  • 错误处理

32-REDCap_API_Adapter开发指南.md

  • Adapter架构设计
  • 代码结构
  • 开发规范
  • 测试方案

33-REDCap二次开发深度指南.md ✅

  • External Modules开发
  • Hooks机制
  • 插件开发
  • 最佳实践

5️⃣ 参考资料

40-REDCap官方资源索引.md

  • 官方文档链接
  • 社区资源
  • 视频教程
  • 常用工具

41-Docker配置文件说明.md

  • Dockerfile详解
  • docker-compose.yml配置
  • 环境变量说明
  • 网络与卷配置

🎯 快速入口

我想部署REDCap

我遇到部署问题

我要进行API开发

我要日常运维

📊 模块当前状态

阶段 状态 完成时间 备注
技术调研 ✅ 完成 2025-12 完成风险评估与方案设计
部署方案设计 ✅ 完成 2026-01-01 确定Docker+ECS方案
本地环境部署 ✅ 完成 2026-01-02 REDCap 15.8.0运行正常
API Adapter开发 ⏳ 进行中 预计2026-01-03 Day 2任务
生产环境部署 📅 计划中 待定 等待API Adapter完成

🔄 文档更新记录

日期 更新内容 更新人
2026-01-02 创建文档体系，完成本地部署 AI Assistant
2025-12-XX 完成技术方案与风险评估文档 AI Assistant

📝 文档编写规范

图标使用规范

  • ⭐ 核心必读文档
  • ✅ 已完成
  • ⏳ 进行中
  • 📅 计划中
  • 🔧 故障排查
  • 🏥 医院专用
  • 💡 技巧提示
  • ⚠️ 重要警告

文档命名规范

  • 按数字分类：01-09系统概览，10-19部署，20-29配置，30-39开发，40-49参考
  • 使用下划线分隔多个单词（而非空格）
  • 重要文档加"完全指南"/"手册"/"指南"后缀

🆘 获取帮助

Reference in New Issue View Git Blame Copy Permalink