Files
sanguo_vnpy_v2/docs
claude_dev 5c8a7e12c6
CI/CD / test (push) Successful in 18s
CI/CD / nas-deploy (push) Failing after 17s
CI/CD / nas-verify (push) Has been skipped
feat(frontend): 终端化重构+策略管理(代码→实例→4运行)+撮合设计+回测参数 [nas]
- 终端化: 科幻色板(tokens/EP/reset/chips/echarts)+Layout(Cmd+K/时钟/状态灯)+mock全接口+Dashboard/Result/Monitor样板+6图表配色
- 策略管理: 策略库三层(代码→实例→4运行)+新建策略(组合/CTA模板+Monaco)+在线代码编辑(Monaco)+实例CRUD(参数反射/标的池type切/interval/match_session)
- 实例→运行关联: backtest/paper/live New页读instance预填
- 撮合设计: match_session(下一根K线开盘/收盘/集合竞价)+interval定频率+实走限日线/分钟走miniQMT
- 回测参数: 基准下拉+日期默认1年localStorage记忆+滑点/手续费UI
- 账户管理页+命名重整(模拟盘/实盘,消除撞名)
- spec §11-13(菜单/策略管理/撮合设计) + Monaco编辑器 + 策略实例删除/编辑入口 + 列表实例列
2026-08-12 23:23:23 +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 全部 初始化文档体系