Files
sanguo_vnpy_v2/docs
claude_dev a68cf4905e feat(portfolio): sanguo_portfolio 组合策略框架(BulletTrade+miniQMT,不用jqdatasdk)
把聚宽"全天候轮动"(post48819)搬到 BulletTrade。融合=pip+扩展点注入
(SanguoMiniQmtProvider 继承 MiniQMTProvider 只 override get_fundamentals,
set_data_provider 公开 API 注入, BulletTrade 源码 0 改动)。

- providers: SanguoMiniQmtProvider 补 get_fundamentals(PershareIndex+自算PE/PS/PB/PCF/市值/ROIC)
- strategies/all_weather: 4选股函数+大小盘轮动+ETF兜底+涨停止损(聚宽风格翻译)
- factors(估值/ROIC自算) + filters(ST/涨跌停/次新/停牌)
- 88/88 测试 Mac+VPS 双过; VPS 回测 pipeline 跑通(修9bug:Capital单位/日期格式/百分数口径/11字段alias)
- 实盘 runner_live+runbook 就绪等交易日; DEFAULT_DATA_PROVIDER=miniqmt env 不装 jqdatasdk
- 文档: sanguo_portfolio_plan / portfolio_backtest_result / portfolio_live_runbook
2026-07-18 19:08:18 +08:00
..

Sanguo VeighNa 文档中心

本目录包含项目的完整文档体系。

📚 文档目录

1. 需求文档 (requirements/)

业务需求、功能需求和非功能需求的存放位置。

  • business/ - 业务需求文档 (BRD)
  • functional/ - 功能需求文档和用户故事
  • non_functional/ - 非功能需求(性能、安全等)

查看详情: requirements/README.md


2. 设计文档 (design/)

技术架构和详细设计文档。

  • architecture/ - 系统架构设计
  • database/ - 数据库设计
  • ui/ - 界面设计和原型
  • integration/ - 接口和集成设计

查看详情: design/README.md


3. API 文档 (api/)

接口定义和 API 规范。

  • rest/ - REST API 文档
  • event/ - 事件定义和说明
  • internal/ - 内部接口定义

查看详情: api/README.md


4. 用户指南 (user_guide/)

面向终端用户的使用文档。

  • quick_start/ - 快速开始指南
  • tutorials/ - 详细教程
  • faq/ - 常见问题

查看详情: user_guide/README.md


5. 运维文档 (operations/)

系统部署、监控和故障排查。

  • deployment/ - 部署文档
  • monitoring/ - 监控指标和告警
  • troubleshooting/ - 故障排查手册

查看详情: operations/README.md


6. 量化研究 (research/)

因子、策略和回测报告。

  • factors/ - 因子研究文档
  • strategies/ - 策略说明文档
  • backtests/ - 回测报告

查看详情: research/README.md


📝 文档规范

命名规范

类型 格式 示例
业务需求 brd-XXX.md brd-001-平台概述.md
功能需求 feature-XXX-模块-功能.md feature-001-gateway-ctp.md
设计文档 system-名称.md system-交易核心.md
API 文档 gateway-接口名.md gateway-ctp-api.md
用户文档 主题.md installation.md

编写规范

  1. 使用 Markdown 格式
  2. 代码块指定语言
  3. 添加必要的图表和示例
  4. 保持与代码同步更新
  5. 使用中文编写,技术术语保留英文

🔗 快速链接


📋 文档更新记录

日期 文档 变更说明
2025-07-01 全部 初始化文档体系