claude_dev
|
a37c43f691
|
docs: 建立完整的项目文档体系
- 创建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>
|
2026-07-01 21:13:44 +08:00 |
|