Skip to content

DOCUMENTATION_GUIDE.md

Latest commit

 

History

History
137 lines (93 loc) · 3.62 KB

DOCUMENTATION_GUIDE.md

File metadata and controls

137 lines (93 loc) · 3.62 KB

文档使用指南

🎯 快速查找

我想...

开始使用项目 → 项目快速启动

运行 Console 应用 → Console 快速启动

管理交易策略 → 策略管理指南

查看常用命令 → 运行命令参考

了解订单同步 → OrderSync 快速参考

解决问题 → 故障排查

查看改进历史 → 开发文档

API 参考 → API 文档

📂 文档结构

docs/
├── README.md                # 📖 文档中心（从这里开始）
├── guides/                  # 👤 用户指南
├── development/             # 🛠️  开发文档
├── api/                     # 🔌 API 参考
└── architecture/            # 🏗️  架构设计

apps/{app}/docs/             # 📱 应用文档
└── console/docs/            # Console 应用

packages/{package}/docs/     # 📦 包文档
└── core/docs/               # Core 包

🚀 新手指南

第一次使用？

  1. 阅读：项目快速启动
  2. 启动：Console 快速启动
  3. 学习：策略管理指南
  4. 参考：运行命令

遇到问题？

  1. 查看：故障排查
  2. 搜索：在 文档中心 搜索关键词
  3. 反馈：提交 Issue

💡 文档规则

创建新文档时，遵循 .cursorrules：

位置选择

  • 应用文档 → apps/{app}/docs/
  • 包文档 → packages/{package}/docs/
  • 项目文档 → docs/{category}/

文档类型

  • Quick Start → apps/{app}/docs/QUICK_START.md
  • 用户指南 → docs/guides/
  • 开发文档 → docs/development/
  • API 文档 → docs/api/ 或 packages/{package}/docs/
  • 架构文档 → docs/architecture/

📚 推荐阅读顺序

1. 入门阶段

  1. 项目快速启动
  2. Console 快速启动
  3. 运行命令

2. 进阶阶段

  1. 策略管理指南
  2. OrderSync 总结
  3. API 参考

3. 深入理解

  1. Console & Web 改进
  2. OrderSync 机制
  3. 架构文档

🔍 文档索引

主要入口

按主题浏览

🎨 文档贡献

创建新文档

  1. 确定类型（用户指南？开发文档？）
  2. 选择位置（应用？包？项目级？）
  3. 创建文件（遵循命名规范）
  4. 更新索引（在相关 README 中添加链接）

文档模板

查看 .cursorrules 获取模板。

需要帮助？ 从 文档中心 开始浏览！ 📖