Files
sanguo_vnpy_v2/docs
claude_dev d1d48896a9
CI/CD / test (push) Successful in 2s
CI/CD / nas-deploy (push) Successful in 6s
CI/CD / nas-verify (push) Successful in 8s
docs(factor): New/Result两页终端风设计稿v1(可交互,任务#12方案B) [nas]
照 tears-compare-mockup 流程先出稿拍板再实现。三tab:
①提交页New:因子多选从Element下拉改「搜索+分组点选」面板(240因子下拉翻页难)
+三类别色chip(101青/158紫/builtin琥珀)+已选托盘chips可删/清空(同对比托盘交互)
+标的池mono textarea实时计数徽标+跨行业30只预设(与详情页一键直达同样本便于复现)
+区间禁未来+跨度显示+提交校验前置(未满足禁用+原因文案)
②结果页Result外壳:5格metric-strip(最优ICIR红/最优因子青)+IC明细终端表格
(右对齐tabular-nums,IC/ICIR/t正红负绿,|t|≥2加粗,全局最优行青标+左青条)
+tears区块虚线占位示意(新版TearsPanel已上线本次不动)
③实现说明:范围/交互变化/拆分预估(New半天+Result1-2小时,纯前端零后端)
种子合成数据mulberry32;charset声明防file://乱码;本机Chrome实测两tab+交互OK
2026-08-30 09:41:49 +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 全部 初始化文档体系