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
parent 8dd1cf326d
commit a37c43f691
7 changed files with 1127 additions and 0 deletions
@@ -0,0 +1,145 @@
+# 设计文档目录
+
+本目录用于存放项目的技术设计文档。
+
+## 目录结构
+
+```
+design/
+├── architecture/      # 架构设计
+│   ├── system-*.md   # 系统架构
+│   ├── module-*.md   # 模块设计
+│   └── sequence-*.md # 时序图
+├── database/         # 数据库设计
+│   ├── schema-*.md   # 数据表结构
+│   └── erd-*.md      # ER图
+├── ui/               # 界面设计
+│   ├── mockup-*.md   # 界面原型
+│   └── workflow-*.md # 交互流程
+└── integration/      # 集成设计
+    ├── gateway-*.md  # 接口集成
+    └── protocol-*.md # 协议定义
+```
+
+## 文档命名规范
+
+| 类型 | 命名格式 | 示例 |
+|-----|---------|------|
+| 系统架构 | `system-名称.md` | `system-交易核心.md` |
+| 模块设计 | `module-模块名.md` | `module-order-engine.md` |
+| 数据表 | `schema-表名.md` | `schema-orders.md` |
+| 原型设计 | `mockup-页面名.md` | `mockup-交易面板.md` |
+| 接口设计 | `gateway-接口名.md` | `gateway-ctp-api.md` |
+
+## 设计文档模板
+
+### 系统架构设计模板
+
+```markdown
+# [系统名称] 架构设计
+
+## 1. 概述
+<!-- 系统定位和目标 -->
+
+## 2. 架构原则
+<!-- 设计原则 -->
+
+## 3. 分层架构
+```mermaid
+graph TB
+    A[表现层] --> B[业务层]
+    B --> C[数据层]
+```
+
+## 4. 核心组件
+### 4.1 组件A
+- 职责
+- 接口
+- 依赖
+
+## 5. 数据流
+```mermaid
+sequenceDiagram
+    A->>B: 请求
+    B->>C: 处理
+```
+
+## 6. 扩展点
+<!-- 可扩展的设计点 -->
+
+## 7. 技术选型
+| 技术 | 用途 | 理由 |
+|-----|------|------|
+| Python | 核心语言 | VeighNa基础 |
+```
+
+### 模块设计模板
+
+```markdown
+# [模块名称] 模块设计
+
+## 1. 模块职责
+<!-- 单一职责描述 -->
+
+## 2. 类设计
+### 2.1 ClassA
+```python
+class ClassA:
+    """类说明"""
+    def method1(self) -> None:
+        """方法说明"""
+        pass
+```
+
+## 3. 状态机
+```mermaid
+stateDiagram-v2
+    [*] --> Created
+    Created --> Active
+    Active --> Closed
+```
+
+## 4. 接口定义
+```python
+from abc import ABC, abstractmethod
+
+class InterfaceA(ABC):
+    @abstractmethod
+    def method(self) -> None:
+        pass
+```
+
+## 5. 异常处理
+| 异常 | 触发条件 | 处理方式 |
+|-----|---------|---------|
+| ExceptionA | 条件A | 方式A |
+
+## 6. 性能考虑
+<!-- 性能指标和优化策略 -->
+```
+
+## 设计评审流程
+
+```mermaid
+graph LR
+    A[设计草稿] --> B[团队评审]
+    B --> C{通过?}
+    C -->|否| A
+    C -->|是| D[设计定稿]
+    D --> E[开发实施]
+```
+
+## 设计原则
+
+1. **SOLID 原则**
+   - 单一职责
+   - 开闭原则
+   - 里氏替换
+   - 接口隔离
+   - 依赖倒置
+
+2. **量化平台特有原则**
+   - 数据一致性优先
+   - 低延迟要求
+   - 高可用保障
+   - 风险控制内置