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>
100 lines
2.0 KiB
Markdown
100 lines
2.0 KiB
Markdown
# 需求文档目录
|
||
|
||
本目录用于存放项目各阶段的需求文档。
|
||
|
||
## 目录结构
|
||
|
||
```
|
||
requirements/
|
||
├── business/ # 业务需求
|
||
│ ├── brd-001.md # 业务需求文档
|
||
│ └── market-*.md # 市场调研文档
|
||
├── functional/ # 功能需求
|
||
│ ├── epic-*.md # 史诗级需求
|
||
│ ├── feature-*.md # 功能需求
|
||
│ └── story-*.md # 用户故事
|
||
└── non_functional/ # 非功能需求
|
||
├── performance.md # 性能需求
|
||
├── security.md # 安全需求
|
||
└── reliability.md # 可靠性需求
|
||
```
|
||
|
||
## 文档命名规范
|
||
|
||
| 类型 | 命名格式 | 示例 |
|
||
|-----|---------|------|
|
||
| 业务需求 | `brd-XXX.md` | `brd-001-平台概述.md` |
|
||
| 功能史诗 | `epic-XXX.md` | `epic-001-交易模块.md` |
|
||
| 功能需求 | `feature-XXX-模块-功能.md` | `feature-001-gateway-ctp.md` |
|
||
| 用户故事 | `story-XXX.md` | `story-001-订单撤单.md` |
|
||
| 接口需求 | `api-XXX.md` | `api-001-行情接口.md` |
|
||
|
||
## 文档模板
|
||
|
||
### 业务需求文档 (BRD) 模板
|
||
|
||
创建 `business/brd-template.md`：
|
||
|
||
```markdown
|
||
# [项目名称] 业务需求文档
|
||
|
||
## 1. 项目背景
|
||
<!-- 项目背景和市场环境 -->
|
||
|
||
## 2. 业务目标
|
||
<!-- 量化的业务目标 -->
|
||
|
||
## 3. 目标用户
|
||
<!-- 用户画像和需求分析 -->
|
||
|
||
## 4. 业务范围
|
||
<!-- 在范围内/外 -->
|
||
|
||
## 5. 竞争分析
|
||
<!-- 竞品分析 -->
|
||
|
||
## 6. 成功指标
|
||
<!-- KPI定义 -->
|
||
```
|
||
|
||
### 功能需求文档模板
|
||
|
||
创建 `functional/feature-template.md`：
|
||
|
||
```markdown
|
||
# [功能名称] 需求文档
|
||
|
||
## 需求概述
|
||
<!-- 一句话描述 -->
|
||
|
||
## 用户角色
|
||
<!-- 谁会使用这个功能 -->
|
||
|
||
## 功能描述
|
||
<!-- 详细功能说明 -->
|
||
|
||
## 验收标准
|
||
- [ ] 标准1
|
||
- [ ] 标准2
|
||
|
||
## 优先级
|
||
P0 / P1 / P2 / P3
|
||
|
||
## 依赖关系
|
||
<!-- 依赖的其他需求 -->
|
||
|
||
## 相关链接
|
||
- Issue: #xxx
|
||
- 设计文档: ../design/xxx.md
|
||
```
|
||
|
||
## 工作流程
|
||
|
||
```mermaid
|
||
graph LR
|
||
A[业务需求] --> B[功能分解]
|
||
B --> C[技术评审]
|
||
C --> D[排期开发]
|
||
D --> E[验收测试]
|
||
```
|