225 lines
10 KiB
Markdown
225 lines
10 KiB
Markdown
# 三国量化任务平台 - 目录结构与工作流规则 (依据AGENTS.md更新)
|
||
|
||
## 项目定位
|
||
本项目是**三国量化交易项目的任务管理与协调平台**,专注于任务分配、进度跟踪和成果管理。
|
||
|
||
## vnpy框架使用原则
|
||
|
||
**尽量使用原生vnpy框架模块,不仿写,不重写,尽量适配**
|
||
- 优先使用vnpy官方提供的组件,避免重复造轮子
|
||
- 对于不满足需求的功能,优先考虑扩展和适配,而非完全重写
|
||
- 保持与vnpy官方架构的兼容性,便于后续升级和维护
|
||
- 只在官方组件无法满足核心需求时,才考虑自定义实现
|
||
|
||
## 技术架构原则
|
||
|
||
**基于vnpy官方架构,遵循分层设计原则**
|
||
- 策略层:使用CtaTemplate等官方策略基类
|
||
- 数据层:使用vnpy官方数据接口和存储组件
|
||
- 平台层:使用Docker容器化部署,保持架构一致性
|
||
- 通信层:使用RPC服务,遵循vnpy官方通信协议
|
||
|
||
## 依据AGENTS.md的团队配置
|
||
|
||
### 指挥层
|
||
| 姓名 | 角色 | 职责 |
|
||
|------|------|------|
|
||
| **诸葛亮** | 总军师 | 任务分配、进度监控、结果汇总、系统修复 |
|
||
| **庞统 士元** | 副军师 | 策略设计、任务拆分、代码整合 |
|
||
| **司马懿 仲达** | 质量总监 | 代码审计、质量复核、最终验收 |
|
||
|
||
### 执行层
|
||
| 姓名 | 角色 | 职责 |
|
||
|------|------|------|
|
||
| **张飞 翼德** | 右路先锋 | vnpy框架改造设计,支持聚宽/QMT多风格兼容,多回测引擎,更好结果展示|
|
||
| **关羽 云长** | 左路先锋 | 风控模块开发、风险控制、安全防护 |
|
||
| **赵云 子龙** | 数据护军 | 数据获取、清洗验证、质量检查 |
|
||
| **姜维 伯约** | 平台总督 | 基础设施选型,开发/测试/生产环境搭建和运维,平台工具链搭建和运维 |
|
||
|
||
## 第一层目录结构(根目录)
|
||
|
||
```
|
||
sanguo_quant_live/ (根目录)
|
||
├── archive/ # 归档目录(放历史文件)
|
||
├── management/ # 项目管理(诸葛亮负责)
|
||
├── strategies/ # 最终成果物:模拟测试脚本
|
||
├── zhaoyun-data/ # 赵云:所有数据相关
|
||
├── guanyu-risk/ # 关羽:所有风控相关
|
||
├── jiangwei-platform/ # 姜维:所有平台相关
|
||
├── zhangfei-technical/ # 张飞:技术策略开发
|
||
├── pangtong-value/ # 庞统:价值投资(基本面策略)
|
||
└── simayi-quality/ # 司马懿:所有质量保证相关
|
||
```
|
||
|
||
## 目录职责说明
|
||
|
||
### 1. archive/ - 归档目录
|
||
- 诸葛亮决定归档内容
|
||
- 按需归档历史文件
|
||
- 保持仓库整洁
|
||
|
||
### 2. management/ - 项目管理(诸葛亮负责)
|
||
- 项目整体规划、进度跟踪
|
||
- 任务分配、优先级管理
|
||
- 最终交付审核
|
||
|
||
### 3. strategies/ - 最终成果物目录
|
||
- **定位**:存放最终可执行的模拟测试脚本
|
||
- **内容**:经过验证的策略脚本、回测框架、性能评估脚本
|
||
- **来源**:各将军完成调研后,将验证通过的脚本提交到这里
|
||
|
||
### 4. 各将军工作区(依据AGENTS.md职责)
|
||
- **zhaoyun-data/** - 赵云:数据获取、清洗验证、质量检查
|
||
- **guanyu-risk/** - 关羽:风控模块开发、风险控制、安全防护
|
||
- **jiangwei-platform/** - 姜维:基础设施选型,开发/测试/生产环境搭建和运维,平台工具链搭建和运维
|
||
- **zhangfei-technical/** - 张飞:vnpy框架改造设计,支持聚宽/QMT多风格兼容,多回测引擎,更好结果展示
|
||
- **pangtong-value/** - 庞统:价值投资(基本面策略)、策略设计、任务拆分、代码整合
|
||
- **simayi-quality/** - 司马懿:代码审计、质量复核、最终验收
|
||
|
||
## 将军目录内部结构(标准模板)
|
||
|
||
```
|
||
将军名-职责/
|
||
├── README.md # 本工作区说明
|
||
├── research/ # 调研报告目录
|
||
│ ├── task-YYYYMMDD-描述/ # 具体调研任务
|
||
│ │ ├── README.md # 任务说明
|
||
│ │ ├── 其他将军子目录/ # 协作任务用
|
||
│ │ └── final/ # 最终整合报告
|
||
│ └── [专项调研目录] # 如:value-investing/, multi-factor/
|
||
├── scripts/ # 本将军的脚本
|
||
│ └── [按功能分类子目录]
|
||
├── data/ # 本将军的数据(主要赵云)
|
||
│ ├── raw/ # 原始数据
|
||
│ ├── processed/ # 处理后的数据
|
||
│ └── running_data/ # 运行数据
|
||
├── reports/ # 报告文档
|
||
└── references/ # 参考资料链接(链接到通用知识库)
|
||
```
|
||
|
||
|
||
|
||
## 工作流规则
|
||
|
||
### 1. 独立任务工作流
|
||
```
|
||
用户需求 → 诸葛亮拆解 → sessions_send分配任务 → 将军完成后提交成果物 → 诸葛亮审核 → 交付
|
||
```
|
||
|
||
**执行方式:**
|
||
1. 诸葛亮通过`sessions_send`直接分配任务给特定将军
|
||
2. 将军完成任务后,将成果物提交到自己目录的相应位置(如`research/`, `scripts/`, `reports/`等)
|
||
3. 诸葛亮审核成果物(归档由诸葛亮决定)
|
||
|
||
### 2. 协作任务工作流
|
||
```
|
||
用户需求 → 确定主导将军 → 主导将军建协作目录 → 各将军提交成果 → 主导将军整合 → 交付
|
||
```
|
||
|
||
**核心原则:谁主导,谁建目录;大家往里放;主导者整合**
|
||
|
||
**示例:多因子选股策略调研(庞统主导)**
|
||
|
||
```
|
||
pangtong-value/research/multi-factor-20240325/ # 庞统创建
|
||
├── README.md # 庞统写:目标、分工、时间线
|
||
├── zhaoyun/ # 赵云提交数据源调研
|
||
│ └── data-sources-report.md
|
||
├── guanyu/ # 关羽提交风险分析
|
||
│ └── risk-assessment.md
|
||
├── jiangwei/ # 姜维提交平台需求
|
||
│ └── platform-requirements.md
|
||
├── zhangfei/ # 张飞提交技术实现
|
||
│ └── technical-implementation.md
|
||
├── simayi/ # 司马懿提交质量审核
|
||
│ └── quality-review.md
|
||
└── final/ # 庞统整合
|
||
├── multi-factor-research-report.md
|
||
└── strategy-prototype.py # 原型脚本,完成后移到strategies/
|
||
```
|
||
|
||
### 3. 沟通方式
|
||
- **任务分配**:诸葛亮通过`sessions_send`直接分配
|
||
- **进度协调**:庞统通过`sessions_send`协调(作为副军师)
|
||
- **将军间协作**:直接在协作目录中放文件,必要时`sessions_send`沟通
|
||
|
||
## 公共知识库规则
|
||
|
||
### 1. 知识库定位和路径
|
||
- **统一的知识库**:所有将军使用同一个公共知识库
|
||
- **具体路径**:`/Users/chufeng/.openclaw/knowledge_base/`
|
||
- **当前内容**:
|
||
```
|
||
/Users/chufeng/.openclaw/knowledge_base/
|
||
├── jqjoinquant/ # 聚宽相关知识和数据
|
||
└── tradingview/ # TradingView相关知识和数据
|
||
```
|
||
- **基础数据存放**:存放原始数据、基础资料、标准定义
|
||
- **分析结果分离**:个人分析结果放在自己的工作目录下
|
||
|
||
### 2. 使用原则
|
||
- **知识库只存放基础数据**:原始数据、基础概念、标准定义、参考资料
|
||
- **分析数据放到各自工作目录**:调研报告、分析结果、处理脚本等个人分析产出,请放在各自将军的工作目录下
|
||
- **禁止污染知识库**:不要将个人分析结果、临时文件、不同分析角度的结果存入知识库
|
||
|
||
### 3. 禁止行为
|
||
- ❌ 不要将个人分析结果存入公共知识库
|
||
- ❌ 不要修改他人已确认的基础数据
|
||
- ❌ 不要在知识库中存放临时文件
|
||
- ❌ 不要污染知识库结构
|
||
|
||
### 4. 正确做法
|
||
- ✅ 从`/Users/chufeng/.openclaw/knowledge_base/`获取基础数据进行分析
|
||
- ✅ 将分析结果保存在自己目录的`reports/`或`analysis/`中
|
||
- ✅ 如需更新知识库数据,提交审核后统一更新
|
||
- ✅ 不同分析角度产生不同结果,各自保存
|
||
|
||
## 文件流转规则
|
||
|
||
### 研发流程
|
||
```
|
||
调研报告(research/) → 原型脚本(scripts/) → 验证通过 → 最终脚本(strategies/)
|
||
```
|
||
|
||
### 质量流程
|
||
```
|
||
各将军产出 → 司马懿质量审核 → 诸葛亮最终审核 → (归档由诸葛亮决定)
|
||
```
|
||
|
||
## 角色职责(依据AGENTS.md)
|
||
|
||
| 角色 | AGENTS.md职责 | 工作目录 | 专项负责 |
|
||
|------|--------------|----------|----------|
|
||
| **诸葛亮** | 任务分配、进度监控、结果汇总、系统修复 | `management/` | 总体管理 |
|
||
| **庞统** | 策略设计、任务拆分、代码整合 | `pangtong-value/` | 价值投资(基本面策略) |
|
||
| **司马懿** | 代码审计、质量复核、最终验收 | `simayi-quality/` | 质量保证 |
|
||
| **张飞** | vnpy框架改造设计,支持聚宽/QMT多风格兼容,多回测引擎,更好结果展示 | `zhangfei-technical/` | 技术策略、回测引擎 |
|
||
| **关羽** | 风控模块开发、风险控制、安全防护 | `guanyu-risk/` | 风控管理 |
|
||
| **赵云** | 数据获取、清洗验证、质量检查 | `zhaoyun-data/` | 数据支持 |
|
||
| **姜维** | 基础设施选型,开发/测试/生产环境搭建和运维,平台工具链搭建和运维 | `jiangwei-platform/` | 平台基础设施 |
|
||
|
||
## 变更记录
|
||
|
||
- 2024-03-25: 创建最终版工作流规则文档
|
||
- **策略分工明确**:庞统负责价值投资(基本面),张飞负责技术策略
|
||
- **目录结构调整**:每个将军一个完整工作区
|
||
- **沟通方式简化**:使用sessions_send直接沟通
|
||
- **制定**:庞统(凤雏)
|
||
- **审核**:诸葛亮
|
||
|
||
## 重要更新 - 2026-03-25 提交方式调整
|
||
|
||
> 📜 **军令**:自今日起,调整项目提交方式:
|
||
> 1. **开发过程不变**:各位将军仍在自己的独立workspace中接收任务、开发调试
|
||
> 2. **成果物提交统一**:完成任务后,请将成果物统一提交到项目目录:
|
||
> ```
|
||
> /Users/chufeng/.openclaw/sanguo_projects/sanguo_quant_live
|
||
> ```
|
||
> 放到各自分工目录下即可,保持原有的目录结构不变
|
||
> 3. **统一推送远程**:所有变更由丞相(诸葛亮)统一审核后提交到Gitee,诸位将军无需自行推送
|
||
>
|
||
> 保持Gitee仓库整洁,避免冲突,由总军师统一把关后再合并,保证项目质量。
|
||
|
||
---
|
||
|
||
*"卧龙风雏,得一可安天下" - 蜀汉量化任务平台工作流* |