Files
sanguo_quant_live/management/workflow-rules.md
T
cfdaily 92c78d9f61 添加目录结构与工作流规则文档 (workflow-rules.md)
- 定义sanguo_quant_live项目定位:任务管理与协调平台
- 制定第一层目录结构:archive/ management/ coordination/ 及各将军工作区
- 规范工作流规则:独立任务和协作任务流程
- 明确角色职责和文件命名规则
- 创建协作任务标准流程:谁主导谁建目录,大家往里放,主导者整合
- 提供现有目录转换计划和实施步骤

由庞统(凤雏)制定,诸葛亮审核
2026-03-25 11:34:21 +08:00

232 lines
7.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 三国量化任务平台 - 目录结构与工作流规则 (sanguo_quant_live项目)
## 项目定位
本项目是**三国量化交易项目的任务管理与协调平台**,专注于任务分配、进度跟踪和成果管理,不存放核心代码。
## 第一层目录结构(根目录)
```
sanguo_quant_live/ (根目录 - 任务管理平台)
├── archive/ # 归档目录(放历史文件)
├── management/ # 项目管理(诸葛亮负责)
├── coordination/ # 协调管理(庞统负责)
├── zhaoyun-data/ # 赵云数据任务区
├── guanyu-risk/ # 关羽风控任务区
├── jiangwei-platform/ # 姜维平台任务区
├── zhangfei-strategy/ # 张飞策略任务区
├── simayi-quality/ # 司马懿质量任务区
└── [本地文件,不上传Gitee]
├── *.log
├── *.monitor.log
└── nohup.out
```
## 目录职责说明
### 1. archive/ - 归档目录
- 存放历史文件、过时文档
- 按日期或主题分类归档
- 保持仓库整洁,不删除历史
### 2. management/ - 项目管理(诸葛亮负责)
- 项目整体规划、进度跟踪
- 任务分配、优先级管理
- 最终交付审核
- **包含本工作流规则文档**
### 3. coordination/ - 协调管理(庞统负责)
- 将军间工作协调
- 协作任务进度跟踪
- 会议记录、沟通协调
### 4. 各将军工作区(命名规则:将军名+职责)
- **zhaoyun-data/** - 赵云:数据相关任务成果
- **guanyu-risk/** - 关羽:风险管理相关任务成果
- **jiangwei-platform/** - 姜维:平台基础设施相关任务成果
- **zhangfei-strategy/** - 张飞:策略开发相关任务成果
- **simayi-quality/** - 司马懿:质量保证相关任务成果
## 现有目录转换计划
### 当前目录 → 新目录
1. `data-engineering/``zhaoyun-data/`
2. `risk-management/``guanyu-risk/`
3. `platform/``jiangwei-platform/`
4. `technical-strategy/``zhangfei-strategy/`
5. 创建新的:`simayi-quality/``coordination/`
6. `management/`(现有)→ 保持不变,补充内容
7. 创建:`archive/`
### 其他目录处理
- `value-investing/` - 保持原状,作为通用策略目录
- `strategies/` - 保持原状,作为通用策略目录
- `running_data/` - 考虑移到`zhaoyun-data/`下或保持
- `scripts/` - 按功能拆分到各将军目录
- `knowledge-base/` - 按主题拆分到各将军目录
## 将军工作区内部结构
### 标准结构(每个将军目录下)
```
将军名-职责/
├── README.md # 本工作区说明
├── individual/ # 个人独立任务
│ ├── task-20240325-xxx.md # 具体任务报告
│ └── task-20240326-yyy.md
├── collaborative/ # 协作任务(可选)
│ └── task-20240325-multi-factor-research/ # 协作任务目录
│ ├── README.md # 任务总说明
│ ├── task-assignment.md # 分工说明
│ ├── zhaoyun/ # 赵云提交的成果
│ ├── guanyu/ # 关羽提交的成果
│ ├── jiangwei/ # 姜维提交的成果
│ ├── simayi/ # 司马懿提交的成果
│ └── final/ # 最终整合成果
├── scripts/ # 任务相关脚本
│ └── download-data.sh
├── reports/ # 报告文档
│ └── monthly-report-202403.md
└── references/ # 参考资料
└── data-sources-list.md
```
## 工作流规则
### 1. 独立任务工作流
```
用户需求 → 诸葛亮拆解 → 分配单一将军 → 将军在自己目录完成 → 提交结果 → 诸葛亮审核 → 交付
```
**执行步骤:**
1. 诸葛亮在`management/tasks/`创建任务文件
2. 分配任务给特定将军
3. 将军在`individual/`目录下创建任务文件:`task-YYYYMMDD-描述.md`
4. 将军完成任务,提交结果
5. 诸葛亮审核,归档到`archive/`
### 2. 协作任务工作流
```
用户需求 → 确定主导将军 → 主导将军建协作目录 → 各将军提交成果 → 主导将军整合 → 交付
```
**执行步骤:**
**阶段1: 任务启动**
1. 诸葛亮确定主导将军(如张飞)
2. 张飞在`zhangfei-strategy/collaborative/`下创建协作目录:`task-YYYYMMDD-描述/`
3. 张飞创建`README.md`(目标、分工、时间线)
4. 张飞创建各将军子目录(按将军名)
**阶段2: 并行执行**
1. 各将军到对应子目录查看任务
2. 各自完成专业部分
3. 提交成果到自己的子目录
**阶段3: 整合交付**
1. 张飞收集各子目录成果
2. 张飞整合到`final/`目录
3. 司马懿质量审核(可单独提交或审核final内容)
4. 诸葛亮最终审核
### 3. 协调工作流(庞统负责)
```
监控各任务进度 → 识别阻塞问题 → 协调将军协作 → 更新协调记录 → 报告诸葛亮
```
**执行位置:** `coordination/`目录下
- `progress-trackers/` - 进度跟踪表
- `meeting-notes/` - 协调会议记录
- `blocking-issues/` - 阻塞问题记录
## 文件命名规则
### 1. 任务文件
- 个人任务:`task-YYYYMMDD-简短描述.md`
- 协作目录:`task-YYYYMMDD-描述/`(目录)
- 报告文件:`report-YYYYMMDD-主题.md`
### 2. 文档文件
- 说明文档:`README.md`
- 指南文档:`xxx-guide.md`
- 清单文档:`xxx-checklist.md`
- 参考文档:`xxx-references.md`
### 3. 脚本文件
- Shell脚本:`xxx.sh`
- Python脚本:`xxx.py`(任务管理相关)
## 协作规则
### 1. 提交规则
- 各将军只在自己的子目录或文件中修改
- 不直接修改其他将军的文件
- 如需修改他人内容,通过协调目录提出建议
### 2. 版本控制
- 所有修改通过Git提交
- 提交信息清晰描述修改内容
- 协作任务:主导将军负责最终整合提交
### 3. 质量保证
- 司马懿负责质量审核
- 审核可在各将军提交时或最终整合时进行
- 质量问题记录在`simayi-quality/quality-issues.md`
## 本地文件管理
### 不上传Gitee的文件
- `*.log` - 日志文件
- `*.monitor.log` - 监控日志
- `nohup.out` - 后台进程输出
- 其他运行时生成的文件
### .gitignore规则(需要更新)
```
# 日志文件
*.log
*.monitor.log
nohup.out
# 临时文件
*.tmp
*.temp
```
## 角色职责表
| 角色 | 主要职责 | 工作目录 |
|------|----------|----------|
| **诸葛亮** | 任务分配、进度监控、结果汇总、系统修复 | `management/` |
| **庞统** | 策略设计、任务拆分、代码整合、将军协调 | `coordination/` |
| **司马懿** | 代码审计、质量复核、最终验收 | `simayi-quality/` |
| **张飞** | vnpy框架改造、多风格兼容、回测引擎 | `zhangfei-strategy/` |
| **关羽** | 风控模块开发、风险控制、安全防护 | `guanyu-risk/` |
| **赵云** | 数据获取、清洗验证、质量检查 | `zhaoyun-data/` |
| **姜维** | 基础设施选型、环境搭建、平台运维 | `jiangwei-platform/` |
## 实施计划
### 阶段1: 规则制定与确认
1. 创建本工作流规则文档
2. 团队评审确认
3. 更新AGENTS.md等文档
### 阶段2: 目录结构调整
1. 重命名现有目录(加将军名前缀)
2. 创建缺失目录(simayi-quality, coordination, archive
3. 整理文件到对应目录
### 阶段3: 工作流实施
1. 按新规则执行首个协作任务
2. 收集反馈,优化流程
3. 固化最佳实践
## 变更记录
- 2024-03-25: 创建工作流规则文档(sanguo_quant_live项目)
- 制定:庞统(凤雏)
- 审核:诸葛亮
---
*"卧龙风雏,得一可安天下" - 蜀汉量化任务平台工作流*