claude_dev
a37c43f691
- 创建6大文档分类：需求/设计/API/用户指南/运维/研究 - 添加各目录的 README 和模板说明 - 定义文档命名规范和编写规范 - 建立文档与代码的对应关系 文档目录结构: ├── requirements/ - 业务需求、功能需求、非功能需求 ├── design/ - 架构设计、数据库设计、UI设计、集成设计 ├── api/ - REST API、事件定义、内部接口 ├── user_guide/ - 快速开始、教程、FAQ ├── operations/ - 部署、监控、故障排查 └── research/ - 因子研究、策略研究、回测报告 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
150 lines
2.8 KiB
Markdown
150 lines
2.8 KiB
Markdown
# 用户指南目录
|
|
|
|
本目录用于存放面向终端用户的文档。
|
|
|
|
## 目录结构
|
|
|
|
```
|
|
user_guide/
|
|
├── quick_start/ # 快速开始
|
|
│ ├── installation.md
|
|
│ ├── first_trade.md
|
|
│ └── first_strategy.md
|
|
├── tutorials/ # 教程
|
|
│ ├── basic/ # 基础教程
|
|
│ ├── advanced/ # 高级教程
|
|
│ └── examples/ # 示例代码
|
|
└── faq/ # 常见问题
|
|
├── general.md
|
|
├── trading.md
|
|
└── strategy.md
|
|
```
|
|
|
|
## 文档命名规范
|
|
|
|
| 类型 | 命名格式 | 示例 |
|
|
|-----|---------|------|
|
|
| 快速开始 | `quick_start/主题.md` | `quick_start/installation.md` |
|
|
| 教程 | `tutorials/分类/主题.md` | `tutorials/basic/cta_strategy.md` |
|
|
| FAQ | `faq/分类.md` | `faq/trading.md` |
|
|
|
|
## 快速开始模板
|
|
|
|
### installation.md
|
|
|
|
```markdown
|
|
# 安装指南
|
|
|
|
## 环境要求
|
|
|
|
- Python 3.10+
|
|
- 推荐使用 Python 3.13
|
|
|
|
## 安装步骤
|
|
|
|
### Windows
|
|
|
|
\`\`\`bash
|
|
# 1. 下载安装包
|
|
# 2. 运行安装程序
|
|
# 3. 验证安装
|
|
python -c "import sanguo_trader; print(sanguo_trader.__version__)"
|
|
\`\`\`
|
|
|
|
### Linux/Mac
|
|
|
|
\`\`\`bash
|
|
# 1. 克隆仓库
|
|
git clone http://192.168.2.154:3000/sanguo/sanguo_vnpy_v2
|
|
|
|
# 2. 安装依赖
|
|
cd sanguo_vnpy_v2
|
|
pip install -r requirements/base.txt
|
|
|
|
# 3. 验证安装
|
|
python -c "import sanguo_trader; print('OK')"
|
|
\`\`\`
|
|
|
|
## 常见问题
|
|
|
|
### Q: 安装失败怎么办？
|
|
A: 检查 Python 版本，使用虚拟环境
|
|
```
|
|
|
|
## 教程模板
|
|
|
|
### tutorials/basic/cta_strategy.md
|
|
|
|
```markdown
|
|
# CTA 策略开发教程
|
|
|
|
## 概述
|
|
|
|
本教程将带你创建一个简单的 CTA 策略。
|
|
|
|
## 前置知识
|
|
|
|
- Python 基础
|
|
- 量化交易基本概念
|
|
|
|
## 步骤 1: 创建策略类
|
|
|
|
\`\`\`python
|
|
from sanguo_trader.strategy import CtaStrategyTemplate
|
|
|
|
class MyStrategy(CtaStrategyTemplate):
|
|
"""我的第一个策略"""
|
|
|
|
def __init__(self, cta_engine, strategy_name, vt_symbol, setting):
|
|
super().__init__(cta_engine, strategy_name, vt_symbol, setting)
|
|
|
|
def on_tick(self, tick):
|
|
"""行情回调"""
|
|
pass
|
|
|
|
def on_order(self, order):
|
|
"""委托回调"""
|
|
pass
|
|
\`\`\`
|
|
|
|
## 步骤 2: 编写交易逻辑
|
|
|
|
...
|
|
|
|
## 步骤 3: 回测验证
|
|
|
|
...
|
|
|
|
## 下一步
|
|
|
|
- 查看[高级教程](../advanced/)
|
|
- 查看[策略库](../../research/strategies/)
|
|
```
|
|
|
|
## FAQ 模板
|
|
|
|
### faq/trading.md
|
|
|
|
```markdown
|
|
# 交易相关常见问题
|
|
|
|
## 委托问题
|
|
|
|
### Q: 为什么委托没有成交？
|
|
A: 可能原因：
|
|
1. 价格偏离市场价太远
|
|
2. 市场流动性不足
|
|
3. 触发了风控规则
|
|
|
|
### Q: 如何修改委托价格？
|
|
A: ...
|
|
```
|
|
|
|
## 文档风格指南
|
|
|
|
1. 使用清晰简洁的语言
|
|
2. 提供可运行的代码示例
|
|
3. 使用截图说明界面操作
|
|
4. 保持文档与代码同步更新
|
|
5. 添加必要的警告和注意事项
|