Files
AIclinicalresearch/docs/_templates/README.md
HaHafeng 31d555f7bb docs: Update architecture docs with platform infrastructure details
- Add platform infrastructure chapter to frontend-backend architecture design
- Update system architecture document with 6 new infrastructure modules
- Update AI onboarding guide with infrastructure overview
- Link to backend/src/common/README.md for detailed usage guide

Key Updates:
- Storage service (LocalAdapter + OSSAdapter)
- Logging system (Winston + JSON format)
- Cache service (Memory + Redis)
- Async job queue (Memory + Database)
- Health check endpoints
- Monitoring metrics
- Database connection pool
- Environment config management

All modules support zero-code switching between local and cloud environments.

Related: #Platform-Infrastructure
2025-11-17 08:36:10 +08:00

1.5 KiB
Raw Blame History

文档模板

目录说明: 本目录包含各类文档的标准模板
使用方法: 创建新文档时,复制对应模板,填充内容


📋 模板清单

模板 说明 适用场景
[AI对接] 快速上下文-模板.md 快速上下文文档模板 创建新模块/能力时
模块README-模板.md 模块README模板 创建新业务模块时

🎯 使用说明

1. 创建新业务模块

步骤:

  1. 复制 模块README-模板.md 到新模块目录
  2. 重命名为 README.md
  3. 填充所有 [占位符] 内容
  4. 删除不需要的章节

2. 创建快速上下文文档

步骤:

  1. 复制 [AI对接] 快速上下文-模板.md 到对应目录
  2. 重命名为 [AI对接] [模块代号]快速上下文.md
  3. 填充所有内容
  4. 确保Token消耗在目标范围内

📏 模板规范

快速上下文文档规范

L0级别总体

  • Token消耗~800
  • 阅读时间2分钟
  • 内容:项目全貌、快速跳转

L1级别层级

  • Token消耗~1500
  • 阅读时间3分钟
  • 内容:层级概览、模块清单

L2级别模块

  • Token消耗~2000
  • 阅读时间5分钟
  • 内容:模块详情、开发指南

🔗 相关文档


最后更新: 2025-11-06
维护人: 技术架构师