claude_dev
58e9a3b053
承接 OpenBB 调研的可落地设计: - 实证本项目兜底坑(NaN当停牌/dbbardata双行/裸查询误报) - TET三段式契约+fail-fast治兜底映射 - 本项目落地方案:extract读本地(绕过网络)+transform pydantic校验 - 明确不照搬OpenBB网络层/Registry/Router(KISS)
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 |
编写规范
- 使用 Markdown 格式
- 代码块指定语言
- 添加必要的图表和示例
- 保持与代码同步更新
- 使用中文编写，技术术语保留英文
🔗 快速链接
📋 文档更新记录
| 日期 | 文档 | 变更说明 |
|---|---|---|
| 2025-07-01 | 全部 | 初始化文档体系 |