发布于vn.py社区公众号【vnpy-community】
 
原文作者：用Python的交易员 | 发布时间：2021-3-31
 

过去几年里，如果问大家vn.py最大的吐槽点是什么，可能大部分人的第一反应就是【文档】。

作为官方团队，之前我们找了很多理由安慰自己：

• 每月一个版本的持续迭代开发任务太重，没时间写~
• 都开源了，用户有问题可以直接看源代码~
• 公众号和知乎专栏有大把详细的分享文章~
• 或者，程序猿（包括Quant）就是不喜欢写文档~

但随着vn.py逐渐成熟，我们越来越多的被用户们提醒着文档的不足，尤其在对比zipline、RQAlpha、backtrader等项目的文档后，更是有一种丑小鸭的自卑感。

所以从2021年初就开始准备全面的文档更新计划，上周2.2.0版本发布后总算是拿出了一点成果。更新后的文档不再去过多介绍内部代码的实现（这算是过去vn.py文档最大的坑之一），而是全部从用户角度出发，来详细讲解各项功能的使用方法和注意事项。

截止本文，已更新完成的文档篇幅包括：

• CtaStrategy - CTA策略模块

• CtaBacktester - CTA回测研究模块

• DataManager - 历史数据管理模块

• PortfolioManager - 投资组合管理模块

• DataRecorder - 行情记录模块

• RiskManager - 事前风控模块

• MarketRadar - 市场信号雷达模块

• PaperAccount - 本地模拟交易模块

• ChartWizard - 实时K线图表模块

目前还在更新中，预计会在二季度全部完成的篇幅：

• 功能介绍

• 安装指南

• 基本使用

• 交易接口

• 数据库配置

• 价差交易模块

• 期权波动率交易模块

• 多合约组合策略模块

• 算法交易

• 脚本策略

• RPC服务

• Excel RTD模块

• 贡献代码

所有文档均可以通过vn.py官网的文档版块直接查看：

https://www.vnpy.com/docs/cn/index.html

同时文档的Markdown源文件，也都包含在Github仓库的docs文件夹下：

https://github.com/vnpy/vnpy/tree/dev/docs

大家在阅读过程中发现内容错误或者改进点，都欢迎直接发起PR到dev-docs分支。

有任何文档相关的建议也欢迎在下方留言，希望今年二季度结束前，可以让我们的用户再也不必为vn.py的文档头疼！